PyBaMM-GEM 0.2.0__tar.gz → 0.2.1__tar.gz

pybamm_gem-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,103 @@
+# Publishes PyBaMM-GEM when a GitHub release is published (tag "v" + the version in pyproject.toml).
+#   1. Build the package and run its tests.
+#   2. Upload to TestPyPI, install it from there and run the tests again.
+#   3. Upload to PyPI. This step waits until a maintainer approves it (GitHub environment "pypi").
+# No tokens are stored anywhere: PyPI and TestPyPI trust this workflow ("trusted publishing").
+# Running it by hand (Actions -> Release -> Run workflow) only does steps 1 and 2, as a test.
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check that the release tag matches the version
+        if: github.event_name == 'release'
+        run: |
+          VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          if [ "v$VERSION" != "$GITHUB_REF_NAME" ]; then
+            echo "The tag is $GITHUB_REF_NAME but pyproject.toml says version $VERSION"
+            exit 1
+          fi
+      - name: Build
+        run: |
+          pip install build twine
+          python -m build
+          twine check dist/*
+      - name: Test the built package
+        run: |
+          pip install dist/*.whl pytest
+          cd /tmp
+          pytest --import-mode=importlib --pyargs pybamm_gem
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    name: Upload to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  check-testpypi:
+    name: Install from TestPyPI and test
+    needs: testpypi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install and test
+        run: |
+          VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          pip install "pybamm[cite]>=26.9" pytest
+          # A new upload can take a few minutes to appear on TestPyPI
+          for attempt in 1 2 3 4 5 6 7 8 9 10; do
+            if pip install --no-deps --index-url https://test.pypi.org/simple/ "pybamm-gem==$VERSION"; then
+              break
+            fi
+            sleep 30
+          done
+          cd /tmp
+          python -c "import pybamm_gem; print(pybamm_gem.__version__, pybamm_gem.list_models())"
+          pytest --import-mode=importlib --pyargs pybamm_gem
+
+  pypi:
+    name: Upload to PyPI (needs approval)
+    needs: check-testpypi
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.2.1
+
+- `pybamm_gem` now has the same commands as the PyBaMM model zoo: `require()` is new, and
+  `info()`, `load()`, `require()` and `register_citation()` accept the class name (for example
+  `"BasicSPM2D"`) as well as the slug (`"spm_2d"`).
+- `info()` fields can be read as `info.title` as well as `info["title"]`.
+
 ## 0.2.0
 
 - Rebuilt in the PyBaMM model-zoo layout: one folder per model, each with a `model.toml`

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: PyBaMM-GEM
-Version: 0.2.0
+Version: 0.2.1
 Summary: Spatially resolved (2D and 3D) battery models for PyBaMM
 Author: Mohammed Asheruddin N
 License-Expression: BSD-3-Clause
@@ -54,6 +54,12 @@ print(solution["Voltage [V]"](1500))
 The classes are also available directly, for example `gem.lithium_ion.BasicSPM2D` or
 `gem.lithium_ion.DFN2D`.
 
+The commands are the same as in the PyBaMM model zoo (`pybamm_model_zoo`): `list_models()`,
+`info()`, `load()`, `require()` and `register_citation()`. `info()`, `load()`, `require()` and
+`register_citation()` take either the slug (`"spm_2d"`) or the class name (`"BasicSPM2D"`);
+`list_models()` returns the slugs. With `pybamm-model-zoo` installed, the GEM models are also
+listed by `pybamm_model_zoo.list_models()`.
+
 The notebook `examples/higher_dimensional_models.ipynb` runs all four models, compares them with
 the stock PyBaMM models and shows a temperature that changes with height.
 
@@ -61,3 +67,12 @@ the stock PyBaMM models and shows a temperature that changes with height.
 
 BSD 3-Clause, see `LICENSE.txt`. Copyright (c) 2026, Imperial College London.
 Some of the model code is adapted from PyBaMM; see `LICENSES-bundled.txt`.
+
+## Releasing a new version
+
+1. In a pull request, raise `version` in `pyproject.toml` (for example `0.2.1`) and add a
+   `CHANGELOG.md` entry. Merge it.
+2. On GitHub, go to Releases, then "Draft a new release". Create the tag `v0.2.1` (a "v" and
+   the version), add a title and notes, and publish.
+3. The Release workflow builds and tests the package, uploads it to TestPyPI and tests it again.
+   It then waits for a maintainer to approve the upload to PyPI (GitHub sends an email).

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/README.md

@@ -37,6 +37,12 @@ print(solution["Voltage [V]"](1500))
 The classes are also available directly, for example `gem.lithium_ion.BasicSPM2D` or
 `gem.lithium_ion.DFN2D`.
 
+The commands are the same as in the PyBaMM model zoo (`pybamm_model_zoo`): `list_models()`,
+`info()`, `load()`, `require()` and `register_citation()`. `info()`, `load()`, `require()` and
+`register_citation()` take either the slug (`"spm_2d"`) or the class name (`"BasicSPM2D"`);
+`list_models()` returns the slugs. With `pybamm-model-zoo` installed, the GEM models are also
+listed by `pybamm_model_zoo.list_models()`.
+
 The notebook `examples/higher_dimensional_models.ipynb` runs all four models, compares them with
 the stock PyBaMM models and shows a temperature that changes with height.
 
@@ -44,3 +50,12 @@ the stock PyBaMM models and shows a temperature that changes with height.
 
 BSD 3-Clause, see `LICENSE.txt`. Copyright (c) 2026, Imperial College London.
 Some of the model code is adapted from PyBaMM; see `LICENSES-bundled.txt`.
+
+## Releasing a new version
+
+1. In a pull request, raise `version` in `pyproject.toml` (for example `0.2.1`) and add a
+   `CHANGELOG.md` entry. Merge it.
+2. On GitHub, go to Releases, then "Draft a new release". Create the tag `v0.2.1` (a "v" and
+   the version), add a title and notes, and publish.
+3. The Release workflow builds and tests the package, uploads it to TestPyPI and tests it again.
+   It then waits for a maintainer to approve the upload to PyPI (GitHub sends an email).

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "PyBaMM-GEM"
-version = "0.2.0"
+version = "0.2.1"
 license = "BSD-3-Clause"
 license-files = ["LICENSE.txt", "LICENSES-bundled.txt"]
 description = "Spatially resolved (2D and 3D) battery models for PyBaMM"

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/src/pybamm_gem/__init__.py

@@ -3,7 +3,7 @@
 from importlib.metadata import version
 
 from pybamm_gem import lithium_ion
-from pybamm_gem._registry import info, list_models, load, register_citation
+from pybamm_gem._registry import info, list_models, load, register_citation, require
 
 __version__ = version("PyBaMM-GEM")
 
@@ -14,4 +14,5 @@ __all__ = [
     "lithium_ion",
     "load",
     "register_citation",
+    "require",
 ]

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/src/pybamm_gem/_registry.py

@@ -26,26 +26,45 @@ def _manifests() -> dict:
     return manifests
 
 
+class ModelInfo(dict):
+    """The manifest of one model. Read a field as ``info["title"]`` or ``info.title``."""
+
+    def __getattr__(self, field):
+        if field in self:
+            return self[field]
+        raise AttributeError(field)
+
+
 def list_models() -> list[str]:
     """Return the slug of every model in the package."""
     return sorted(_manifests())
 
 
-def info(slug: str) -> dict:
-    """Return the manifest of one model as a dictionary."""
+def info(name: str) -> ModelInfo:
+    """Return the manifest of one model, found by its slug ("spm_2d") or class name ("BasicSPM2D")."""
     manifests = _manifests()
-    if slug not in manifests:
-        raise KeyError(f"No model '{slug}'. Available: {sorted(manifests)}")
-    return manifests[slug]
+    for slug in manifests:
+        if name == slug or name == manifests[slug]["name"]:
+            return ModelInfo(manifests[slug])
+    raise KeyError(f"No model '{name}'. Available: {sorted(manifests)}")
 
 
-def load(slug: str) -> type:
-    """Return the model class for a slug. Call it to get a model, e.g. ``load("spm_2d")()``."""
-    module_path, class_name = info(slug)["class"].split(":")
+def load(name: str) -> type:
+    """Return the model class, e.g. ``load("spm_2d")()`` or ``load("BasicSPM2D")()``."""
+    module_path, class_name = info(name)["class"].split(":")
     module = importlib.import_module(module_path)
     return getattr(module, class_name)
 
 
+def require(name: str) -> None:
+    """Check that a model exists (raises KeyError if not).
+
+    The same command as in the PyBaMM model zoo. GEM models need no optional
+    packages, so there is nothing else to check.
+    """
+    info(name)
+
+
 def _read_bibtex(path: Path) -> dict:
     # Split a BibTeX file into {key: entry text} by matching braces.
     text = path.read_text(encoding="utf-8")
@@ -69,9 +88,9 @@ def _read_bibtex(path: Path) -> dict:
     return entries
 
 
-def register_citation(slug: str) -> None:
+def register_citation(name: str) -> None:
     """Make ``pybamm.print_citations()`` credit the model's key from its ``CITATION.bib``."""
-    manifest = info(slug)
+    manifest = info(name)
     entries = _read_bibtex(manifest["path"] / "CITATION.bib")
     key = manifest["citation"]["key"]
     pybamm.citations.register(entries[key])

{pybamm_gem-0.2.0 → pybamm_gem-0.2.1}/tests/test_registry.py

@@ -35,3 +35,38 @@ def test_every_model_folder_has_the_zoo_files():
             assert (folder / name).is_file(), f"{slug}: missing {name}"
         assert any((folder / "tests").glob("*.py")), f"{slug}: no tests"
         assert any((folder / "examples").glob("*.py")), f"{slug}: no examples"
+
+
+# The same commands as the PyBaMM model zoo (pybamm_model_zoo)
+
+
+def test_load_by_slug_or_class_name_gives_the_same_class():
+    for slug in gem.list_models():
+        class_name = gem.info(slug)["name"]
+        assert gem.load(class_name) is gem.load(slug)
+
+
+def test_info_by_class_name():
+    assert gem.info("BasicSPM2D")["slug"] == "spm_2d"
+    assert gem.info("DFN3D")["slug"] == "dfn_3d"
+
+
+def test_info_fields_as_attributes_or_items():
+    manifest = gem.info("spm_2d")
+    assert manifest.title == manifest["title"]
+    assert manifest.license == "BSD-3-Clause"
+    with pytest.raises(AttributeError):
+        print(manifest.no_such_field)
+
+
+def test_require():
+    for slug in gem.list_models():
+        gem.require(slug)
+    gem.require("BasicSPM3D")
+    with pytest.raises(KeyError):
+        gem.require("no_such_model")
+
+
+def test_register_citation_by_slug_or_class_name():
+    gem.register_citation("spm_2d")
+    gem.register_citation("DFN2D")