In order to make use of the PyMedPhys library, you’ll need Python installed on your workstation. Although not essential, we recommend that you install the Anaconda Python distribution. Instructions for installing Anaconda can be found here.
Once you have a suitable Python installation, you can install the latest stable version of PyMedPhys via conda or pip as follows:
Installing via Conda from conda-forge (recommended)¶
PyMedPhys can be installed via the conda-forge channel. To install, run the following commands in your terminal:
conda config --add channels conda-forge conda create --name pmp python=3.7 # Optional. conda activate pmp # Optional conda install pymedphys
The optional commands create an isolated conda environment called “pmp” within which you can safely work without breaking other python installations or running into python package incompatibilities. For more on working with conda environments, see *Managing environments* in the Conda docs.
Installing via pip from PyPI¶
Alternatively, you can install via pip as follows:
pip install pymedphys
Note that issues with some of PyMedPhys’ dependencies may arise if you choose to install via this method.
Installing the “bleeding edge” version from GitHub¶
You can install the very latest, “bleeding edge”, development version of PyMedPhys by directly cloning its GitHub repo and installing its dependencies using the following commands from within a terminal:
git clone https://github.com/pymedphys/pymedphys.git cd pymedphys conda config --add channels conda-forge conda create --name pmp python=3.7 # Optional. conda activate pmp # Optional conda install pymedphys --only-deps pip install -e .
Note that this requires Git to be installed on your workstation. Instructions for installing Git can be found in the Developer Guide.