Merge pull request #3 from pymt-lab/mdpiper/update-to-meson

Update build system for Python >=3.12

.github/workflows/format.yml

@@ -0,0 +1,14 @@
+name: Format
+
+on: [push, pull_request]
+
+jobs:
+  format:
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+      - uses: psf/black@stable

.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+
+      - name: Lint
+        run: |
+          pip install flake8
+          flake8 pymt_gipl examples

.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build-and-test:
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: latest
+          activate-environment: fbld
+          environment-file: environment.yml
+          python-version: ${{ matrix.python-version }}
+
+      - name: Show conda installation info
+        run: |
+          conda info
+          conda list
+
+      - name: Build and install package
+        run: |
+          make install
+
+      - name: Test import
+        working-directory: ${{ github.workspace }}/examples
+        run: |
+          python -c 'import pymt_gipl'
+          python -c 'from pymt.models import GIPL'
+
+      # The bmi-tester isn't available for bmi-fortran=1.2
+      # - name: Test BMI
+      #   run: |
+      #     make test
+
+      - name: Run examples
+        working-directory: ${{ github.workspace }}/examples
+        run: |
+          python gipl_bmi_ex.py
+          python gipl_pymt_ex.py

CHANGES.md

@@ -0,0 +1,17 @@
+# Changelog
+
+A record of changes for the *pymt_gipl* package.
+
+## 0.2.0 (unreleased)
+
+- Nothing changed yet.
+
+
+## 0.1.1 (2020-10-16)
+
+- Use custom cd context instead of scripting package
+
+
+## 0.1 (2019-08-14)
+
+- GIPL BMI and pymt examples complete

CREDITS.md

@@ -0,0 +1,3 @@
+# Credits
+
+* Kang Wang <[email protected]>

MANIFEST.in

@@ -1,2 +1,7 @@
-include versioneer.py
-include pymt_gipl/_version.py
+include *.md
+include Makefile
+include babel.toml
+include environment.yml
+include meson.build
+include examples/*
+recursive-include meta *

Makefile

@@ -29,7 +29,7 @@ BROWSER := python -c "$$BROWSER_PYSCRIPT"
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+clean: clean-build clean-compile clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
 
 clean-build: ## remove build artifacts
 	rm -fr build/
@@ -38,6 +38,13 @@ clean-build: ## remove build artifacts
 	find . -name '*.egg-info' -exec rm -fr {} +
 	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 {} +
+	rm -fr build/
+
 clean-pyc: ## remove Python file artifacts
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
@@ -51,14 +58,18 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 pymt_gipl
+	flake8 pymt_gipl examples
 
 pretty:
 	find pymt_gipl -name '*.py' | xargs isort
-	black setup.py pymt_gipl
+	black . --check
 
 test: ## run tests quickly with the default Python
-	bmi-test pymt_gipl.bmi:GIPL -vvv
+	bmi-test pymt_gipl._bmi:GIPL \
+		--config-file=${PWD}/examples/gipl_config.cfg \
+		--root-dir=examples \
+		--bmi-version="1.2" \
+		-vvv
 
 test-all: ## run tests on every Python version with tox
 	tox
@@ -84,9 +95,8 @@ release: dist ## package and upload a release
 	twine upload dist/*
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	python -m build --no-isolation
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	python setup.py develop
+	python -m pip install . -v --no-build-isolation

README.md

@@ -0,0 +1,56 @@
+# pymt_gipl
+
+[![Basic Model Interface](https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg)](https://bmi.readthedocs.io/)
+
+[![Test](https://github.com/pymt-lab/pymt_gipl/actions/workflows/test.yml/badge.svg)](https://github.com/pymt-lab/pymt_gipl/actions/workflows/test.yml)
+
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pymt_gipl.svg)](https://anaconda.org/conda-forge/pymt_gipl)
+
+PyMT plugin for GIPL
+
+- Free software: MIT license
+- Documentation: <https://gipl.readthedocs.io>.
+
+  | Component | PyMT
+  | --------- | ----------------------------
+  | GIPL      | from pymt.models import GIPL
+
+## Installing pymt
+
+Installing pymt from the conda-forge channel
+can be achieved by adding conda-forge to your channels with:
+``` 
+conda config --add channels conda-forge
+```
+
+*Note*: Before installing pymt, you may want to create a
+separate environment into which to install it. This can be done with,
+``` 
+conda create -n pymt python=3
+conda activate pymt
+```
+
+Once the conda-forge channel has been enabled,
+pymt can be installed with:
+``` 
+conda install pymt
+```
+
+It is possible to list all of the versions of pymt
+available on your platform with:
+``` 
+conda search pymt --channel conda-forge
+```
+
+## Installing pymt_gipl
+
+Once pymt is installed, the dependencies of
+pymt_gipl can be installed with:
+``` 
+conda install bmi-fortran=1.2 gipl
+```
+
+To install pymt_gipl,
+``` 
+conda install pymt_gipl
+```