Skip to content

Commit 10b44cd

Browse files
committed
Add example for constructing flexible water model
1 parent fb40c27 commit 10b44cd

File tree

10 files changed

+1707
-1
lines changed

10 files changed

+1707
-1
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ files. If your example needs such data files, there are a few options available:
4949
- if the data files are small (few 10s of Kb) you may also include them in a
5050
``data/`` folder within the example folder. A zip file will be generated that
5151
can be downloaded from the example page.
52+
- for a Python file that should not be rendered you can save it with a leading
53+
underscore, e.g. ``_my_script.py``.
5254

5355
.. _sphinx-gallery: https://sphinx-gallery.github.io/
5456
.. _RestructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
setuptools
12
sphinx
23
sphinx-sitemap
34
sphinx-design
45
sphinx-gallery
56
sphinx-toggleprompt
7+
sphinxcontrib-details-directive
68
docutils
79
furo
810
chemiscope>=0.7

docs/src/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"sphinx_design",
1010
"sphinx.ext.viewcode",
1111
"sphinx.ext.intersphinx",
12+
"sphinxcontrib.details.directive",
1213
"sphinx_gallery.load_style",
1314
"chemiscope.sphinx",
1415
]

examples/water-model/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.pt

examples/water-model/README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Empircal water models
2+
=====================
3+
4+
This example shows implemenetations of three and four point flexible water models and
5+
uses them to run molecular dynamics simulations of water.

examples/water-model/conf.gro

Lines changed: 642 additions & 0 deletions
Large diffs are not rendered by default.

examples/water-model/environment.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
channels:
2+
- conda-forge
3+
dependencies:
4+
- python=3.11
5+
- pip
6+
- pip:
7+
- ase
8+
- chemiscope>=0.7
9+
- metatensor-torch
10+
- metatensor-operations
11+
- matplotlib
12+
- torch-pme

0 commit comments

Comments
 (0)