Installation

There are two ways to install pymt on your local machine:

If you plan to use pymt to run and couple models, installing a stable release is a good option. However, if you intend to develop with pymt, possibly modifying it, it’s best to install it from source.

If you encounter any problems when installing pymt, please visit us at the CSDMS Help Desk and explain what occurred.

Stable release

We strongly recommend using mamba to install and run pymt. If you don’t have mamba installed, the Anaconda installation guide can help you through the process.

Once you’ve installed Anaconda/conda, we suggest using the mamba package manager. mamba is pretty much the same as conda, only faster. If you would rather stick with conda, just replace occurances of mamba with conda.

$ conda install mamba

add the conda-forge channel to the list of enabled conda channels on your machine:

$ mamba config --add channels conda-forge

We advise installing pymt into a conda environment. Conda environments can easily be created and discarded. Create an environment for pymt with:

$ mamba create -n pymt python=3

Once the conda environment has been created, activate it with:

$ conda activate pymt

Install pymt into this conda environment with:

$ mamba install pymt

Note that pymt is built on several open source software libraries, so it may take a few minutes for mamba to find, download, and install them.

You’re now ready to start using pymt. Check the installation by starting a Python session and importing pymt:

>>> import pymt.models
=> models: (none)

By default, no models are installed with pymt. Instructions for installing models into pymt are given in the section Install a model.

From source

We strongly recommend using mamba to install and run pymt. If you don’t have mamba installed, the Anaconda installation guide can help you through the process.

Once you’ve installed Anaconda/conda, we suggest using the mamba package manager. mamba is pretty much the same as conda, only faster. If you would rather stick with conda, just replace occurances of mamba with conda.

$ conda install mamba

add the conda-forge channel to the list of enabled conda channels on your machine:

$ mamba config --add channels conda-forge

We advise installing pymt into a conda environment. Conda environments can easily be created and discarded. Create an environment for pymt with:

$ mamba create -n pymt python=3

Once the conda environment has been created, activate it with:

$ conda activate pymt

The source code for pymt can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/csdms/pymt

Or download the tarball:

$ curl -OL https://github.com/csdms/pymt/tarball/master

Once you have a copy of the source, install the pymt dependencies into the conda environment you created above:

$ mamba install --file=requirements.txt

Then install pymt with:

$ pip install -e .

You’re now ready to start using pymt. Check the installation by starting a Python session and importing pymt:

>>> import pymt.models
=> models: (none)

By default, no models are installed with pymt. Instructions for installing models into pymt are given in the section Install a model.