Setup and Installation

Dependencies

pyTMD is dependent on several open source programs that can be installed using OS-specific package management systems (e.g. apt or homebrew), conda or from source:

Installation

pyTMD is available for download from the GitHub repository, the Python Package Index (pypi), and from conda-forge.

The simplest installation for most users will likely be using conda or mamba:

conda install -c conda-forge pytmd

conda installed versions of pyTMD can be upgraded to the latest stable release:

conda update pytmd

To use the development repository, please fork pyTMD into your own account and then clone onto your system:

git clone https://github.com/pyTMD/pyTMD.git

pyTMD can then be installed within the package directory using pip:

python3 -m pip install --user .

To include all optional dependencies:

python3 -m pip install --user .[all]

The development version of pyTMD can also be installed directly from GitHub using pip:

python3 -m pip install --user git+https://github.com/pyTMD/pyTMD.git