Skip to content

Commit 5d1c386

Browse files
committed
Updated setupy.py and the installation instructions in the ddocumentation
1 parent dbe2f7d commit 5d1c386

File tree

3 files changed

+14
-24
lines changed

3 files changed

+14
-24
lines changed

docs/getting_started.rst

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,19 @@
44
running, and analyzing GROMACS simulation ensembles. The current implementation is
55
mainly for synchronous ensemble of expanded ensemble (EEXE), but we will develop
66
methods like asynchronous EEXE, or ensemble of alchemical metadynamics in the future.
7-
In the current implementation, `gmxapi`_, which is a higher level Python API of GROMACS,
7+
In the current implementation, the module :code:`subprocess`
88
is used to launch GROMACS commands, but we will switch to `SCALE-MS`_ for this purpose
99
in the future when possible.
1010

1111

12-
.. _`gmxapi`: https://manual.gromacs.org/current/gmxapi/
1312
.. _`SCALE-MS`: https://scale-ms.readthedocs.io/en/latest/
1413

1514

1615
2. Installation
1716
===============
1817
2.1. Requirements
1918
-----------------
20-
Before installing :code:`ensemble_md`, one should have working versions of `GROMACS`_
21-
and `gmxapi`_. Please refer to the linked documentations for full installation instructions.
19+
Before installing :code:`ensemble_md`, one should have working versions of `GROMACS`_. Please refer to the linked documentations for full installation instructions.
2220
All the other pip-installable dependencies of :code:`ensemble_md` (specified in :code:`setup.py` of the package)
2321
will be automatically installed during the installation of the package.
2422

@@ -31,14 +29,6 @@ will be automatically installed during the installation of the package.
3129

3230
pip install ensemble-md
3331

34-
By default, the command above does not install :code:`gmxapi`, so one needs to either
35-
following the full installation instruction of :code:`gmxapi`, or install
36-
:code:`gmxapi` along with the package (after sourcing the GROMACS excutable, e.g.
37-
:code:`/usr/local/gromacs/bin/GMXRC`) with the following command:
38-
::
39-
40-
pip install ensemble-md[gmxapi]
41-
4232
2.3. Installation from source
4333
-----------------------------
4434
One can also install :code:`ensemble_md` from the source code, which is available in our
@@ -49,8 +39,7 @@ One can also install :code:`ensemble_md` from the source code, which is availabl
4939
cd ensemble_md/
5040
pip install .
5141

52-
To install the pacakg along with :code:`gmxapi`, replace the last command with
53-
:code:`pip install '.[gmxapi]'`. If you are interested in contributing to the project, append the
42+
If you are interested in contributing to the project, append the
5443
last command with the flag :code:`-e` to install the project in the editable mode
5544
so that changes you make in the source code will take effects without re-installation of the package.
5645
(Pull requests to the project repository are welcome!)

ensemble_md/ensemble_EXE.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ def check_gmx_executable(self):
351351
self.gmx_version = line.split()[-1]
352352
break
353353
except subprocess.CalledProcessError:
354-
print(f"{self.check_gmx_executable()} is not available on this system.")
354+
print(f"{self.gmx_executable} is not available on this system.")
355355
except Exception as e:
356356
print(f"An error occurred:\n{e}")
357357

setup.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,22 @@
9393
'seaborn',
9494
'matplotlib',
9595
'pyemma',
96+
'mpi4py'
9697
],
9798

98-
# The following extra_require directive provides optional dependencies by, in our case, pip install ensemble[gmxapi].
99+
# (OBSOLETE) The following extra_require directive provides optional dependencies by, in our case, pip install ensemble[gmxapi].
99100
# ensemble_md requires GROMACS and gmxapi to be installed before use.
100101
# If a working version of GROMACS is available, the user can choose to install ensemble_md along with gmxapi
101102
# using the following command: `pip install ensemble_md[gmxapi]`. Otherwise, follow installation
102103
# instructions of GROMACS and gmxapi to install each package separately.
103-
extras_require={
104-
'gmxapi': [
105-
'pybind11>=2.6',
106-
'setuptools>=42.0',
107-
'mpi4py',
108-
'gmxapi>=0.4.0rc2'
109-
],
110-
},
104+
105+
# extras_require={
106+
# 'gmxapi': [
107+
# 'pybind11>=2.6',
108+
# 'setuptools>=42.0',
109+
# 'gmxapi>=0.4.0rc2'
110+
# ],
111+
# },
111112

112113
platforms=['Linux',
113114
'Mac OS-X',

0 commit comments

Comments
 (0)