Fix the test CI workflow (#7)

* Bring bmi-example-c to v2.0.3

* Match file structure from pymt_heatf

* Move bmi module to _bmi

* Use absolute imports

* Convert rst documents to markdown

* Update syntax for calling bmi-tester

* Don't use an editable install

There's some trickiness where Meson puts files and model_metadata
expects to find them.

* Set minimum pymt at v1.3.2

* Raise minimum Python to 3.11

* Separate dev and lint optional project dependencies

* Update project urls

* Don't try to clean C source files

* Make pretty

* Fix the test workflow on unix

Author: mdpiper

.github/workflows/test.yml

@@ -3,13 +3,9 @@ name: Test
 on: [push, pull_request]
 
 jobs:
-  build-and-test:
-    # We want to run on external PRs, but not on our own internal PRs as they'll be run
-    # by the push to the branch. Without this if check, checks are duplicated since
-    # internal PRs match both the push and pull_request events.
+  build-test-unix:
     if:
-      github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
-      github.repository
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
 
     runs-on: ${{ matrix.os }}
 
@@ -20,33 +16,37 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - uses: mamba-org/setup-micromamba@v1
+      - uses: mamba-org/setup-micromamba@v2
         with:
           micromamba-version: latest
           environment-file: environment.yml
 
-      - name: Build and install model
+      - name: Build and install HeatModelC
         run: |
           mkdir build && pushd build
           cmake ../external/bmi-example-c -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX
           make install
           popd
 
-      - name: Build and install package
+      - name: Build and install project
         run: |
-          pip install --no-build-isolation --editable .
+          make install
 
-      - name: Test BMI
+      - name: Test imports
+        working-directory: ${{ github.workspace }}/examples
         run: |
           python -c 'import pymt_heatc'
-          bmi-test pymt_heatc.bmi:HeatModelC --config-file=examples/config.txt --root-dir=examples -vvv
+          python -c 'from pymt.models import HeatModelC'
+
+      - name: Test BMI
+        run: |
+          make test
 
       - name: Run examples
         working-directory: ${{ github.workspace }}/examples

CHANGES.rst CHANGES.mdCHANGES.rst renamed to CHANGES.md

@@ -1,35 +1,29 @@
-Changelog for pymt_heatc
-========================
+# Changelog for pymt_heatc
 
-0.5 (unreleased)
-----------------
+## 0.5 (unreleased)
 
 - Nothing changed yet.
 
 
-0.4 (2023-11-02)
-----------------
+## 0.4 (2023-11-02)
 
 - Rebuild project with Meson (#6)
 
 
-0.3 (2021-09-01)
-----------------
+## 0.3 (2021-09-01)
 
 - Standardize BMI and pymt examples (#2)
 - Rename component from HeatModel to HeatModelC (#3)
 - Show total temperature in BMI example (#5)
 
 
-0.2 (2021-08-20)
-----------------
+## 0.2 (2021-08-20)
 
 - Add metadata files from babelizer C example
 - Add examples of running BMI and through pymt
 - Rerender with babelizer v0.3.8
 
 
-0.1.0 (2020-03-10)
-------------------
+## 0.1.0 (2020-03-10)
 
 - Initial version with output from bmi-render

CREDITS.md

@@ -0,0 +1,3 @@
+# Credits
+
+- Mark Piper

CREDITS.rst

@@ -38,7 +38,6 @@ clean-build: ## remove build artifacts
 	find . -name '*.egg' -exec rm -f {} +
 
 clean-compile: ## remove compilation artifacts
-	find . -name '*.c' -exec rm -f {} +
 	find . -name '*.mod' -exec rm -f {} +
 	find . -name '*.o' -exec rm -f {} +
 	find . -name '*.so' -exec rm -f {} +
@@ -64,7 +63,11 @@ pretty:
 	black . --check
 
 test: ## run tests quickly with the default Python
-	bmi-test pymt_heatc.bmi:HeatModelC -vvv
+	bmi-test pymt_heatc._bmi:HeatModelC \
+		--config-file=${PWD}/examples/config.txt \
+		--root-dir=examples \
+		--bmi-version="2.0" \
+		-vvv
 
 test-all: ## run tests on every Python version with tox
 	tox
@@ -83,4 +86,4 @@ dist: clean ## builds source and wheel package
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	pip install --no-build-isolation --editable .
+	python -m pip install . -v --no-build-isolation

Makefile

@@ -0,0 +1,30 @@
+# pymt_heatc
+
+This is an example of building a model, written in C and wrapped in
+Python with the [babelizer](https://github.com/csdms/babelizer), with
+the [meson-python](https://meson-python.readthedocs.io/en/latest/) build
+system using a `pyproject.toml` file to describe the build.
+
+## Build/Install
+
+This is a sketch of how to build and install this project.
+
+1. Create the conda environment from [environment.yml](./environment.yml) and activate it.
+2. Build/install the [C BMI example](https://github.com/csdms/bmi-example-c/#buildinstall)
+3. Build/install this project with `make install`
+
+## Use
+
+Import the standalone project into a Python session:
+
+``` python
+>>> import pymt_heatc
+```
+
+Import the *pymt* component:
+
+``` python
+>>> from pymt.MODELS import HeatModelC
+```
+
+Try the examples in the [examples](./examples/) directory.

README.md

@@ -1,17 +1,19 @@
-# An env for re/building a C pymt-lab component with Meson.
+# A conda environment for re/building a C pymt-lab component with Meson.
 name: cbld
 channels:
   - conda-forge
 dependencies:
   - python =3
   - pip
   - make
-  - cmake
+  - cmake         # [bmi-example-c]
   - pkg-config
   - bmi-c
   - c-compiler
+  - cxx-compiler  # [win]
   - cython
   - meson-python
+  - python-build
   - numpy
   - bmi-tester >=0.5.5
-  - pymt >=1.3
+  - pymt >=1.3.2

README.rst

@@ -1,4 +1,5 @@
 """Run the heatc model through its BMI in Python."""
+
 import numpy as np
 from pymt_heatc import HeatModelC
 

environment.yml

@@ -1,4 +1,5 @@
 """Run the heatc model in pymt."""
+
 import numpy as np
 from pymt.models import HeatModelC