Skip to content

Commit da7eb40

Browse files
committed
amending/adding installation instructions (fixes #141)
1 parent 1fddb68 commit da7eb40

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

Diff for: README.md

+43-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ If you do not have conda, please follow the instructions here:
3838

3939
https://conda.io/miniconda.html
4040

41+
#### Installing the tutorials as a package
42+
4143
After installing miniconda, you can install the tutorial either via
4244

4345
``` bash
@@ -56,6 +58,35 @@ If you intend to install with pip, for which can not give any support, you feel
5658
pip install git+https://github.com/markovmodel/pyemma_tutorials
5759
```
5860

61+
#### Manual installation
62+
63+
If you wish to install the tutorial manually, you will need the following packages (including all their dependencies):
64+
65+
- `pyemma`
66+
- `mdshare`
67+
- `nglview`
68+
- `nbexamples`
69+
- `jupyter_contrib_nbextensions`
70+
71+
This can be done, for example, with conda:
72+
73+
```bash
74+
conda install -c conda-forge pyemma mdshare nglview nbexamples jupyter_contrib_nbextensions
75+
```
76+
77+
After installing `jupyter_contrib_nbextensions`, you need to activate the `toc2` and `exercise2` extensions:
78+
79+
```bash
80+
jupyter nbextension enable toc2/main
81+
jupyter nbextension enable exercise2/main
82+
```
83+
84+
Now all remains is to clone the repository to get the tutorial notebooks:
85+
86+
```bash
87+
git clone https://github.com/markovmodel/pyemma_tutorials.git
88+
```
89+
5990
### Usage
6091
Now we have a fresh conda environment containing the notebooks and the software to run them. We can now just activate the environment and run the notebook server by invoking:
6192

@@ -66,6 +97,18 @@ pyemma_tutorials
6697

6798
The last command will start the notebook server and your browser should pop up pointing to a list of notebooks. You can choose either to preview or to create your own copy of the notebook. The latter will create a copy of the chosen notebook in your home directory, so your changes will not be lost after shutting down the notebook server.
6899

100+
If you have a manual installation, move to the repository's notebook directory...
101+
102+
```bash
103+
cd path_to_pyemma_tutorials/notebooks
104+
```
105+
106+
... and start the notebook server there:
107+
108+
```bash
109+
jupyter notebook
110+
```
111+
69112
### Deinstallation
70113

71114
To uninstall you can remove the whole environment which will also uninstall the contained software again:
@@ -78,4 +121,3 @@ or if you have installed the package directly
78121
``` bash
79122
conda remove pyemma_tutorials
80123
```
81-

Diff for: manuscript/manuscript.tex

+10-1
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,17 @@ \subsection{Software/system requirements}
102102
We utilize Jupyter~\cite{jupyter} notebooks to show code examples along with figures and interactive widgets to display molecules.
103103
The user can install all necessary packages in one step using the \texttt{conda} command provided by the Anaconda Python stack (\url{https://anaconda.com}).
104104
We recommend Anaconda because it resolves and installs dependencies as well as provides pre-compiled versions of common packages.
105-
106105
The tutorial installation contains a launcher command to start the Jupyter notebook server as well as the notebook files.
106+
107+
You can install the tutorial's dependencies in a new conda environment and start the notebook server via
108+
\begin{verbatim}
109+
conda create -n pyemma_tutorials
110+
conda activate pyemma_tutorials
111+
conda install -c conda-forge pyemma_tutorials
112+
pyemma_tutorials
113+
\end{verbatim}
114+
or refer to \githubrepository{} for more detailed installation and usage instructions.
115+
107116
The data for the demonstrated test systems is downloaded upon the first use and is cached for future invocations of the tutorial.
108117

109118
The underlying software stack for running the tutorial consists of:

0 commit comments

Comments
 (0)