Skip to content

Commit

Permalink
Fix docs dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
ifd3f committed Oct 15, 2022
1 parent 20f568c commit ffc3bd0
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 38 deletions.
2 changes: 0 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ API Documentation

.. autosummary::
:toctree: autosummary

MDSAPT.canvas
1 change: 1 addition & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. automodule:: mdsapt.config
1 change: 0 additions & 1 deletion docs/optimizer.rst

This file was deleted.

66 changes: 37 additions & 29 deletions docs/quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,40 @@ The following steps describe how to set up the input YAML file.
Here is an example of a filled-out YAML file:

.. code-block:: yaml
topology_path: 'testtop.psf'
trajectory_paths:
- 'testtraj.dcd'
selection_resid_num:
- 11
- 199
int_pairs:
# Place pair of selections defined above in a list of lists
- [11, 199]
trajectory_settings:
start: 0
stop: 98
step: 1
system_settings:
ncpus: '12'
memory: '12GB'
time: '24:00:00'
opt_settings:
pH: 7
sapt_settings:
method: 'sapt0'
basis: 'jun-cc-pvdz'
psi4:
method: "sapt0"
basis: "jun-cc-pvdz"
settings:
reference: 'rhf'
save_psi4_output: true
reference: "rhf"
save_output: true
simulation:
ph: 7.0
charge_guesser: "standard"
# charge_guesser: 'rdkit' # to use rdkit. Make sure it is installed first.
system_limits:
ncpus: 32
memory: "80GB"
analysis:
### This section is for running TrajectorySAPT. To run other types of analyses, see below.
type: "trajectory"
topology: testtop.psf
trajectories:
- testtraj.dcd
pairs:
# Place pair of selections defined above in a list of lists
- [109, 196]
- [197, 199]
- [208, 200]
- [156, 44]
- [84, 13]
frames:
start: 78
stop: 97
step: 1
output: "output.csv"
Running SAPT
____________
Expand Down Expand Up @@ -98,11 +107,10 @@ Here is some code demonstrating it:
import mdsapt
Settings = mdsapt.InputReader('runinput.yaml')
Opt = mdsapt.Optimizer(Settings)
SAPT_run = mdsapt.TrajectorySAPT(Settings, Opt)
SAPT_run.run(Settings.start, Settings.stop, Settings.step)
SAPT_run.results.to_csv('results.csv')
config = mdsapt.load_from_yaml_file('runinput.yaml')
sapt_run = mdsapt.TrajectorySAPT(config)
sapt_run.run(config.start, config.stop, config.step)
sapt_run.results.to_csv('results.csv')
See also `the Binder demo <https://mybinder.org/v2/gh/calpolyccg/MDSAPT_demo/master?labpath=MD-SAPT_demo.ipynb>`_ for a bigger example.

1 change: 0 additions & 1 deletion docs/reader.rst

This file was deleted.

5 changes: 5 additions & 0 deletions docs/requirements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ channels:
dependencies:
- python
- pip

- pydantic
- pyyaml
- click

- sphinx
- sphinx_rtd_theme

5 changes: 0 additions & 5 deletions mdsapt/viewer.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@
automatically installed by your package manager because it is an optional
dependency.
Required Input:
- :class:`-mdsapt.reader.InputReader
- :class:`-mdsapt.optimizer.Optimizer
.. autoclass:: Viewer
:members:
:inherited-members:
Expand Down

0 comments on commit ffc3bd0

Please sign in to comment.