Installation

Warning

This is an experimental release. Documentation remains a work in progress. Some sections may be incomplete or under development.

pyISSM can be installed using pip or conda, or by cloning the repository from GitHub. Below are instructions for each method.

Installing via pip

You can install pyISSM using pip, the Python package manager. See the official release on PyPI: https://pypi.org/project/pyissm/

Run the following command in your terminal:

pip install pyissm

Installing via conda

If you prefer using conda, you can install pyISSM from the accessnri channel. https://anaconda.org/channels/accessnri/packages/pyissm/overview

conda install accessnri::pyissm

Installing from GitHub (Development Version)

You can also install the latest development version directly from the GitHub repository:

Clone the repository:

git clone https://github.com/ACCESS-NRI/pyISSM.git

Navigate to the cloned directory:
```
cd pyissm
```
Install pyISSM using pip:
```
pip install .
```

Note

Installing from GitHub is recommended only if you want the latest features or are contributing to pyISSM development.

pyISSM conda environment

An environment.yml file is provided in the repository to create an optional conda environment with all necessary dependencies to use pyISSM. You can create the environment using the following command:

conda env create -f environment.yml

Once created, you can activate the environment with:

conda activate pyissm

Alternatively, for NCI Gadi users, you can use the pre-installed conda/analysis3 Python Environment maintained within the xp65 project to run pyISSM. More information and instructions on how to use conda/analysis3 can be found on the ACCESS-Hive Docs conda/analysis3 page.

Verifying the Installation

After installation, you can verify the selected pyISSM version is installed correctly by running the following commands in a Python shell:

import pyissm
print(pyissm.__version__)