Skip to content

Commit 94c4975

Browse files
authored
Cleanup structure; update README (#1)
* Move input files for notebook 4 and 5 to inputs/ * Update readme * Add binder; badges to README * add info on notebook 5; update history
1 parent 923348e commit 94c4975

File tree

6 files changed

+20
-5
lines changed

6 files changed

+20
-5
lines changed

4_mstis_sampling_tutorial.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,9 @@
219219
"source": [
220220
"# some aspects of storage depend on Python version\n",
221221
"if sys.version_info > (3,):\n",
222-
" filename = \"mstis_bootstrap_py3.nc\"\n",
222+
" filename = \"./inputs/mstis_bootstrap_py3.nc\"\n",
223223
"else:\n",
224-
" filename = \"mstis_bootstrap_py2.nc\""
224+
" filename = \"./inputs/mstis_bootstrap_py2.nc\""
225225
]
226226
},
227227
{

5_advanced_customize_shooting.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"metadata": {},
5050
"outputs": [],
5151
"source": [
52-
"storage = paths.Storage(\"2_state_toy.nc\", mode='r')\n",
52+
"storage = paths.Storage(\"./inputs/2_state_toy.nc\", mode='r')\n",
5353
"state_A = storage.volumes['A']\n",
5454
"state_B = storage.volumes['B']\n",
5555
"cv = storage.cvs['x']\n",

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/openpathsampling/ops_tutorial/HEAD?urlpath=lab)
2+
![Tests](https://github.com/openpathsampling/ops_tutorial/workflows/Tests/badge.svg)
3+
![GitHub last commit](https://img.shields.io/github/last-commit/openpathsampling/ops_tutorial)
4+
15
# OpenPathSampling Alanine Dipeptide Tutorial
26

37
This is an introductory tutorial for OpenPathSampling, and is generally the
@@ -23,6 +27,12 @@ and
2327

2428
## Requirements
2529

30+
If you'd prefer not to install things locally, you can try out the tutorial
31+
using [this Binder
32+
link](https://mybinder.org/v2/gh/openpathsampling/ops_tutorial/HEAD?urlpath=lab).
33+
Performance is likely to be better on your own computer than on Binder, but
34+
Binder is useful if you can't/don't want to install the software.
35+
2636
### Software
2737

2838
Note that OpenPathSampling does not support Windows; if you're using a Windows
@@ -90,12 +100,17 @@ Notebook 4 is optional, and has no exercises in it. It provides setup for a
90100
very different kind of system (a 2D toy model), and illustrates that the
91101
overall setup process is the same, regardless of the underlying engine.
92102

103+
Notebook 5 contains some more advanced exercises related to TIS, and also shows
104+
how to use the OPS command line interface. In addition to the requirements
105+
listed above, it requires installation of `openpathsampling-cli`.
106+
93107
## History
94108

95109
This tutorial has been used in multiple classes and workshops, including
96110
several E-CAM Extended Software Development Workshops (Leiden, The Netherlands,
97-
2017; Lyon, France, 2019), and Master's-level courses in Biomolecular
98-
Simulation at the University of Amsterdam (2017--2019).
111+
2017; Lyon, France, 2019), Master's-level courses in Biomolecular Simulation at
112+
the University of Amsterdam (since 2017), and the CECAM flagship school MolSim
113+
(2021).
99114

100115
This tutorial was developed with financial support from the European Union's
101116
Horizon 2020 research and innovation program, under grant agreement No. 676531
File renamed without changes.

0 commit comments

Comments
 (0)