Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstring for analysis_particle_indices in MultiStateReporter #676

Merged
merged 5 commits into from Apr 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions openmmtools/multistate/multistatereporter.py
Expand Up @@ -97,8 +97,8 @@ class MultiStateReporter(object):
The reporter internally tracks what data goes into which file, so its transparent to all other classes
In the future, this will be able to take Storage classes as well
analysis_particle_indices : tuple of ints, Optional. Default: () (empty tuple)
Indices of particles which should be treated as special when manipulating read and write functions.
If this is an empty tuple, then no particles are treated as special
If specified, it will serialize positions and velocities for the specified particles, at every iteration, in the
reporter storage (.nc) file. If empty, no positions or velocities will be stored in this file for any atoms.

Attributes
----------
Expand Down
16 changes: 7 additions & 9 deletions readthedocs.yml
@@ -1,15 +1,13 @@
conda:
file: devtools/conda-envs/test_env.yaml
version: 2

# The default for requirements_file is null, but for some reason we get an error with this message if it's not set:
# "Problem parsing YAML configuration. Invalid "requirements_file": path docs/requirements.txt does not exist"
requirements_file: null
conda:
environment: devtools/conda-envs/test_env.yaml

build:
image: latest
os: ubuntu-22.04
tools:
python: mambaforge-4.10

python:
version: 3.6
setup_py_install: true
sphinx:
configuration: docs/conf.py
fail_on_warning: false