Skip to content

Commit e6a8ee7

Browse files
committed
Update installation instructions to recommend conda environments and specify Python version 3.10 or higher. Include additional software dependencies and installation notes.
1 parent 6b53682 commit e6a8ee7

File tree

1 file changed

+35
-36
lines changed

1 file changed

+35
-36
lines changed

docs/source/installation/dependencies.rst

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,25 @@ Virtual python environment
77
MISPR depends on a number of third party Python packages, and usually on
88
specific versions of those packages. In order not to interfere with third
99
party packages needed by other software on your machine or cluster, we
10-
strongly recommend isolating MISPR in a virtual python environment. In the
11-
following, we describe how to create a virtual python environment using
12-
the `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ tool, but
13-
feel free to use your preferred environment manager
14-
(e.g. `conda <https://conda.io/docs/>`_).
10+
strongly recommend isolating MISPR in a conda environment. In the
11+
following, we describe how to create a conda environment using
12+
the `conda <https://docs.conda.io/projects/conda/en/latest/>`_ tool.
1513

16-
.. tip::
17-
:title: Recommendation
14+
.. important::
1815

19-
We recommend that you use Python version 3.7 since this is the version that we have
20-
tested MISPR with.
16+
MISPR requires Python version 3.10 or higher. We have extensively tested MISPR with Python 3.10.
2117

22-
Creating the virtual environment
18+
Creating a conda environment
2319
=================================
20+
Before creating a conda environment, ensure that Anaconda or Miniconda is installed on your system.
21+
Most HPC clusters provide Anaconda as a loadable module. If you need to install it yourself, you can
22+
install Miniconda by following the `official installation guide <https://docs.conda.io/projects/miniconda/en/latest/>`_.
23+
2424
To create and activate a new virtual environment, go to your
2525
``|CODES_DIR|`` (see :doc:`Definition <../keywords>`), and run the following commands::
2626

27-
pip install --user --upgrade virtualenv # install virtualenv tool
28-
python -m virtualenv mispr_env # create "mispr_env" environment
29-
source mispr_env/bin/activate # activate "mispr_env" environment
27+
conda create -n mispr_env python=3.10 # create "mispr_env" environment
28+
conda activate mispr_env # activate "mispr_env" environment
3029

3130
This will create a directory in your ``|CODES_DIR|`` named ``mispr_env``,
3231
where all the packages will be installed. After activation, your prompt
@@ -36,13 +35,13 @@ that python programs have access only to packages installed inside the
3635
virtualenv.
3736
To deactivate the enviornment, simply run::
3837

39-
deactivate
38+
conda deactivate
4039

4140
.. note::
42-
You may need to install ``pip`` and ``setuptools`` in your virtual
43-
enviornment in case the system or user version of these tools is old::
41+
You may need to install ``pip`` and ``setuptools`` in your conda
42+
environment in case the system or user version of these tools is old::
4443

45-
pip install -U setuptools pip
44+
conda install pip setuptools
4645

4746
Computational chemistry software
4847
---------------------------------
@@ -51,16 +50,23 @@ At the backend, MISPR uses:
5150

5251
* `Gaussian <https://gaussian.com>`_ software to perform DFT calculations
5352
* `AmberTools <https://ambermd.org/AmberTools.php>`_ to generate GAFF parameters
53+
* `Schrodinger <https://www.schrodinger.com/>`_ (optional) to automatically generate
54+
OPLS2005 parameters
5455
* `LAMMPS <https://www.lammps.org/#gsc.tab=0>`_ to run MD simulations
5556
* `Packmol <https://m3g.github.io/packmol/download.shtml>`_ to
5657
create initial configurations for MD simulations. To install packmol,
5758
follow their `user guide <https://m3g.github.io/packmol/userguide.shtml>`_
59+
* `OpenBabel <https://openbabel.org/wiki/Main_Page>`_ to handle molecule operations
60+
via pymatgen as an interface. You can install OpenBabel using conda::
61+
62+
conda install -c conda-forge openbabel=3.1.1
5863

5964
Ensure that you have access to the executables of these software
6065
before using MISPR. Gaussian is a commercial software
61-
that requires a license while AmberTools, LAMMPS, and Packmol are open source.
62-
If Gaussian, AmberTools, and LAMMPS are already installed on supercomputing
63-
resources, the user typically needs to load their corresponding modules
66+
that requires a license while AmberTools, LAMMPS, and Packmol are open source.
67+
Schrodinger also requires a license, though academic licenses are available for university researchers.
68+
If Gaussian, AmberTools, Schrodinger and LAMMPS are already installed on HPC
69+
machines, the user typically needs to load their corresponding modules
6470
before their use.
6571

6672
Materials Project base libraries
@@ -73,14 +79,10 @@ Materials Project base libraries
7379
to use MISPR, you need to install the MolMD version of pymatgen by
7480
running the following commands in your ``|CODES_DIR|``::
7581

76-
git clone https://github.com/molmd/pymatgen.git
77-
cd pymatgen
78-
python setup.py install
79-
* `FireWorks <https://materialsproject.github.io/fireworks/>`_: MISPR
80-
uses FireWorks to design, manage, and execute workflows. To install,
81-
simply type::
82+
pip3 install pymatgen@git+https://github.com/molmd/pymatgen@molmd_fix_3-9#egg=pymatgen
8283

83-
pip install FireWorks
84+
* `FireWorks <https://materialsproject.github.io/fireworks/>`_: MISPR
85+
uses FireWorks to design, manage, and execute workflows.
8486

8587
Further details can be found in the `FireWorks documentation <https://materialsproject.github.io/fireworks/installation.html>`_.
8688

@@ -92,19 +94,16 @@ Materials Project base libraries
9294
* `custodian <https://materialsproject.github.io/custodian/>`_: MISPR uses
9395
custodian for handling errors that occur during the simulations and
9496
correcting them according to predefined rules. We have added a Gaussian
95-
plug-in to the custodian library, but similar to the pymatgen changes,
96-
these changes have not been merged yet with the main custodian library.
97-
Therefore, in order to use MISPR, you need to install the MolMD version
98-
of custodian by running the following commands in your ``|CODES_DIR|``::
97+
plug-in to the custodian library, and these changes have been merged with
98+
the main custodian library.
9999

100-
git clone https://github.com/molmd/custodian.git
101-
cd custodian
102-
python setup.py install
100+
.. note::
101+
FireWorks and custodian will be automatically installed as dependencies when you
102+
install MISPR. You don't need to install them separately.
103103

104104
MongoDB
105105
-------------------------
106-
Following the design decisions of the Materials Project, MISPR uses
107-
`MongoDB <https://docs.mongodb.com/manual/>`__ as the backend database.
106+
MISPR uses `MongoDB <https://docs.mongodb.com/manual/>`__ as the backend database.
108107
MongoDB is a NoSQL database that is designed to store and retrieve
109108
data in a highly efficient and scalable manner. It stores data in the
110109
form of documents represented in the JSON (JavaScript Object Notation)

0 commit comments

Comments
 (0)