Installation¶
The OpenMiChroM library can be installed via pip, conda, or compiled from source (GitHub).
Install via pip¶
The code below will install OpenMiChroM from PyPI:
pip3 install OpenMiChroM
Note
OpenMiChroM relies on the OpenMM API to run chromatin dynamics simulations. OpenMM can now also be installed via pip, which may be preferable for some users. OpenMM is now available as a pip-installable package. You can install it using pip openmm[cuda12] to iinstall to use with GPU’s or openmm to install for CPU’s only:
pip install openmm[cuda12]
Alternatively, if you prefer using conda, install OpenMM from the conda-forge channel with:
conda install -c conda-forge openmm
Install via conda¶
If you prefer using conda, you can install OpenMiChroM from conda-forge with the following command:
conda install -c conda-forge OpenMiChroM
Hint
Sometimes, the installation via conda may appear to be stuck. If this happens, update conda/anaconda using the command below and try installing OpenMiChroM again.
conda update --prefix /path/to/anaconda3/ anaconda