# pyISSM: Release Information

**URL:** <https://forum.access-hive.org.au/t/pyissm-release-information/6994>\
**Category:** ACCESS-NRI Releases\
**Tags:** python, release, tools, access-issm, pyissm\
**Created:** [16 September 2026 01:00 UTC](https://forum.access-hive.org.au/t/pyissm-release-information/6994 "2026-09-16T01:00:12Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![mtetley](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/mtetley/32/495_2.png) [@mtetley](https://forum.access-hive.org.au/u/mtetley)\
**Post date:** [16 September 2026 01:00 UTC](https://forum.access-hive.org.au/t/pyissm-release-information/6994/1 "2026-09-16T01:00:12Z")

</div>

# What is this?

A topic that will be used to announce release information and updates for `pyISSM`.

# What is pyISSM?

`pyISSM` is a Python API for the open source [Ice-sheet and Sea-level System Model](https://issm.jpl.nasa.gov/) (ISSM). `pyISSM` provides a suite of tools focused on creating, parameterising, executing, visualising, and analysing ISSM models optimised for use on NCI infrastructure via the supported [ACCESS-ISSM](https://forum.access-hive.org.au/t/access-issm-release-information/6993) releases.

> **[GitHub - ACCESS-NRI/pyISSM: Python API for the Ice-sheet and Sea-level System...](https://github.com/ACCESS-NRI/pyISSM)**
>
> Python API for the Ice-sheet and Sea-level System Model (ISSM)

# How is this topic used?

This topic will be the place where release information and updates to `pyISSM` will be announced, with details of what those updates entail.

# What should I do to be notified of any updates?

You can [watch this topic](https://forum.access-hive.org.au/t/access-issm-release-information/6993), and be notified by email of _every_ update.

# Where do I ask questions about releases?

Replies to this topic are disabled.

If you have specific questions about this release [follow the guidelines for requesting help from ACCESS-NRI](https://forum.access-hive.org.au/t/access-help-and-support/908).

If you have questions about #pyissm please create a topic in the relevant channel within #Cryosphere > pyISSM community space. If you require assistance [follow the guidelines for requesting help from ACCESS-NRI](https://forum.access-hive.org.au/t/access-help-and-support/908).

---

<div class="post-metadata">

**Author:** ![mtetley](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/mtetley/32/495_2.png) [@mtetley](https://forum.access-hive.org.au/u/mtetley)\
**Post date:** [16 September 2026 01:00 UTC](https://forum.access-hive.org.au/t/pyissm-release-information/6994/2 "2026-09-16T01:00:26Z")

</div>



---

<div class="post-metadata">

**Author:** ![mtetley](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/mtetley/32/495_2.png) [@mtetley](https://forum.access-hive.org.au/u/mtetley)\
**Post date:** [16 September 2026 22:55 UTC](https://forum.access-hive.org.au/t/pyissm-release-information/6994/3 "2026-09-16T22:55:38Z")

</div>

# pyISSM release

🚀 **Release** : `pyISSM` v0.2.1

**What can you expect to be able to do with this?**

A user should be able to

- install `pyISSM` into their own Python environment from PyPI, conda or GitHub, or use it on NCI _Gadi_ through the `conda/analysis3` environment.
- create, parameterise, execute, visualise and analyse [Ice-sheet and Sea-level System Model (ISSM)](https://github.com/ISSMteam/ISSM) models from Python, rather than MATLAB.
- work through the provided tutorial notebooks, which build and run a square ice shelf and a Pine Island Glacier configuration.

## About pyISSM

_pyISSM_ is a Python API for the open source [Ice-sheet and Sea-level System Model (ISSM)](https://issmteam.github.io/ISSM-Documentation/), maintained by ACCESS-NRI. It provides a suite of tools focused on creating, parameterising, executing, visualising and analysing ISSM models, allowing users to set up, run and analyse ice sheet simulations using Python.

pyISSM is developed around a central `Model()` class, and comprises five major sub-packages:

- `pyissm.model` - the core `Model()` class, all model sub-classes, and the operations used to build and parameterise a model (`bc`, `execute`, `io`, `mesh`, `param`).
- `pyissm.tools` - universal tools for interacting with ISSM `Model()` objects.
- `pyissm.data` - tools for interacting with external datasets, including interpolation routines.
- `pyissm.plot` - visualisation utilities, including plotting of model meshes, boundary conditions, fields and results.
- `pyissm.analysis` - post-processing tools, including derived fields and metrics.

An additional `pyissm.inversion` sub-package provides tools for performing inversions, including sensitivity analyses, on the `Model()` object.

### 📢 **THIS IS A BETA RELEASE** 📢

This is a beta release of pyISSM while rolling out features currently found in the MATLAB interface and getting feedback from the community.

More information on release stages are available on the Hive Docs:

[Release stages - ACCESS-Hive Docs](https://docs.access-hive.org.au/about/releases/#release-stages-for-model-configurations)

## Feedback

We welcome feedback from all interested users. This is a chance to improve this proposed new release.

Please make suggestions or report problems via relevant channels within #Cryosphere > pyISSM community space on this forum, or by [submitting an issue on GitHub](https://github.com/ACCESS-NRI/pyISSM/issues).

ACCESS-NRI is interested in all feedback, positive or negative, but in particular we would like to know:

- Are the instructions clear and easy to follow? Is there anything unclear, missing or incorrect?
- Are there ISSM workflows you rely on that pyISSM does not yet support?

## How to use

Install from PyPI:

```auto
pip install pyissm

```

or with conda, from the `accessnri` channel:

```auto
conda install accessnri::pyissm

```

An `environment.yml` file is provided in the repository to create a conda environment with all the necessary dependencies. For NCI _Gadi_ users, pyISSM is also supported through the pre-installed [`conda/analysis3` environment](https://docs.access-hive.org.au/getting_started/environments/) maintained within the `xp65` project. If using `conda/analysis3` we currently recommend using kernels older than `25.10`.

To verify the installation:

```python
import pyissm
print(pyissm. __version__ )

```

- [pyISSM documentation](https://pyissm.readthedocs.io/latest/) — [overview](https://pyissm.readthedocs.io/latest/overview.html), [installation](https://pyissm.readthedocs.io/latest/installation.html), [tutorials](https://pyissm.readthedocs.io/latest/tutorials.html) and [API reference](https://pyissm.readthedocs.io/latest/pyissm.html)
- Tutorial notebooks: [pyISSM Introduction](https://pyissm.readthedocs.io/latest/tutorials/1_pyISSM_intro.html), [Example 1 – Square Ice Shelf](https://pyissm.readthedocs.io/latest/tutorials/ex1_SquareIceShelf.html), [Example 2 – Pine Island Glacier](https://pyissm.readthedocs.io/latest/tutorials/ex2_PineIslandGlacier.html)

To execute models, pyISSM requires an ISSM installation with the Python wrappers enabled. On _Gadi_, this is provided by the ACCESS-NRI [ACCESS-ISSM](https://github.com/ACCESS-NRI/ACCESS-ISSM) deployment, which is built with `+wrappers` and `+py-tools`. More information about the latest releases of ACCESS-ISSM can be found [here](https://forum.access-hive.org.au/t/access-issm-release-information/6993).

## Features

✅ A central `Model()` class as a high-level container for all components of an ISSM model, with sub-classes defining model components and parameterisations (`mesh`, `geometry`, and so on).  
✅ Mesh construction, boundary condition setting, parameterisation, and model marshalling and execution from Python.  
✅ Model read/write (`pyissm.model.io`) for moving models in and out of Python workflows.  
✅ Inversion and sensitivity analysis tools.  
✅ Plotting of meshes, boundary conditions, fields and results.  
✅ Data handling and interpolation routines for external datasets, complementing the [Cryosphere Community Datapool](https://docs.access-hive.org.au/model_evaluation/data/cryosphere_datapool/) and [`ccdtools`](https://github.com/ACCESS-NRI/ccdtools).  
✅ Available from [PyPI](https://pypi.org/project/pyissm/) and [conda](https://anaconda.org/accessnri/pyissm), with [documentation](https://pyissm.readthedocs.io/latest/), a full API reference and hands-on tutorial notebooks.  
✅ Requires Python 3.9 or later. Apache-2.0 licensed. Built on xarray, numpy, scipy, netCDF4, pandas, matplotlib, attrs, PyYAML and geopandas.

## Limitations

🛑 pyISSM is in currently in active development. The API may change between releases.  
🛑 pyISSM does not include ISSM itself. A working ISSM installation with Python wrappers is required to execute models.  
🛑 Not all ISSM functionality available through the MATLAB interface is exposed in pyISSM in this release.

## Future developments

🚧 Learning Modules - more in-depth material on the different components of pyISSM.  
🚧 Continued expansion of the API, tutorials and documentation to reach ‘parity’ with MATLAB interface.  
🚧 Closer integration with [`ccdtools`](https://github.com/ACCESS-NRI/ccdtools) and the [Cryosphere Community Datapool](https://docs.access-hive.org.au/model_evaluation/data/cryosphere_datapool/) for model initialisation.  
🚧 Support for the [ACCESS-AIS3](https://github.com/ACCESS-NRI/ACCESS-AIS3) whole-Antarctic configuration.

## Credits (Latest developments only)

⭐ Development of pyISSM (@lawrenceabird @justinh2002 @mtetley)

⭐ Documentation and tutorials (@lawrenceabird @justinh2002 @mtetley)

⭐ Build, packaging and release infrastructure (@lawrenceabird @justinh2002 @mtetley)

⭐ Feedback and testing from the [Cryospheric Sciences Working Group](https://forum.access-hive.org.au/c/cryosphere/34)

## Support

Replies to this topic are disabled.

If you have specific questions about **this release** please add a topic on this forum and tag with #help ([more information about support](https://forum.access-hive.org.au/t/access-help-and-support/908) for ACCESS-NRI’s released software).

## Resources

- [pyISSM GitHub repository](https://github.com/ACCESS-NRI/pyISSM)
- [pyISSM documentation](https://pyissm.readthedocs.io/latest/)
- [pyissm on PyPI](https://pypi.org/project/pyissm/) and [on conda](https://anaconda.org/accessnri/pyissm)
- [ISSM documentation](https://issmteam.github.io/ISSM-Documentation/) and [upstream ISSM source](https://github.com/ISSMteam/ISSM)
- [ACCESS-ISSM model deployment repository](https://github.com/ACCESS-NRI/ACCESS-ISSM)
- [ccdtools](https://github.com/ACCESS-NRI/ccdtools) and the [Cryosphere Community Datapool](https://docs.access-hive.org.au/model_evaluation/data/cryosphere_datapool/)
- [Cryospheric Sciences Working Group - ACCESS-Hive Forum](https://forum.access-hive.org.au/c/cryosphere/working-group/45)
- [Contributing to pyISSM](https://pyissm.readthedocs.io/latest/contributing.html)
