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

Rejuvenate API refs #527

Merged
merged 16 commits into from
Aug 30, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"sphinx.ext.intersphinx",
"sphinx.ext.autosummary",
"docs._ext.sass",
"sphinx.ext.mathjax",
]

intersphinx_mapping = {
Expand All @@ -70,7 +71,9 @@
autodoc_default_options = {
"members": True,
"member-order": "bysource",
"inherited-members": "GufeTokenizable,BaseModel"
"inherited-members": "GufeTokenizable,BaseModel",
"undoc-members": True,
"special-members": "__call__",
}
toc_object_entries_show_parents = "hide"

Expand Down
4 changes: 2 additions & 2 deletions docs/cookbook/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The typical way to use the Python API is to load a number of molecules you want
Atom mappings from another tool.

.. rst-class:: arrow-down
-
- :any:`Ligand Network Loaders`

- -
.. rst-class:: flowchart-spacer
Expand All @@ -70,7 +70,7 @@ The typical way to use the Python API is to load a number of molecules you want
Hand-write an atom mapping.

.. rst-class:: arrow-down
-
- :any:`Ligand Network Loaders`

- :class:`LigandNetwork`
A network of ligand transformations.
Expand Down
47 changes: 0 additions & 47 deletions docs/reference/api/alchemical_data_objects.rst

This file was deleted.

42 changes: 24 additions & 18 deletions docs/reference/api/alchemical_network_planning.rst
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
.. _Alchemical Network Planning:

Alchemical Network Planning
===========================
Simulation Campaign Planning
============================

Alchemical network planners are objects that pull all the ideas in OpenFE
into a quick setup for simulation. The goal is to create the
:class:`.AlchemicalNetwork` that represents an entire simulation campaign,
starting from a bare amount of user input. This also requries several helper
classes along the way.
While a :class:`LigandNetwork` describes a network of ligands and their atom
mappings, a :class:`AlchemicalNetwork` describes a single replicate of a
simulation campaign. It includes all the information needed to perform the
simulation, and so implicitly includes the :class:`LigandNetwork`.

Alchemical Network Planners
---------------------------
Alchemical Simulations
~~~~~~~~~~~~~~~~~~~~~~

.. module:: openfe.setup
:noindex:
Descriptions of anticipated alchemical simulation campaigns.

.. module:: openfe
:noindex:

.. autosummary::
:nosignatures:
:toctree: generated/

RBFEAlchemicalNetworkPlanner
RHFEAlchemicalNetworkPlanner

Transformation
AlchemicalNetwork

Chemical System Generators
--------------------------
Alchemical Network Planners
---------------------------
Alchemical network planners are objects that pull all the ideas in OpenFE
into a quick setup for simulation. The goal is to create the
:class:`.AlchemicalNetwork` that represents an entire simulation campaign,
starting from a bare amount of user input.

.. module:: openfe.setup.chemicalsystem_generator
.. module:: openfe.setup
:noindex:

.. autosummary::
:nosignatures:
:toctree: generated/

EasyChemicalSystemGenerator
RBFEAlchemicalNetworkPlanner
RHFEAlchemicalNetworkPlanner
13 changes: 13 additions & 0 deletions docs/reference/api/data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Data Objects and Serialization
==============================

.. module:: gufe.tokenization

Almost every OpenFE data object inherits from :class:`GufeTokenizable`, which
enforces immutability and provides functions for data serialization.

.. autosummary::
:nosignatures:
:toctree: generated/

GufeTokenizable
34 changes: 17 additions & 17 deletions docs/reference/api/defining_and_executing_simulations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,41 @@ Executing Simulations
---------------------

.. module:: openfe
:noindex:
:noindex:

.. autosummary::
:nosignatures:
:toctree: generated/
:nosignatures:
:toctree: generated/

execute_DAG
execute_DAG

General classes
---------------

.. module:: openfe
:noindex:
:noindex:

.. autosummary::
:nosignatures:
:toctree: generated/
:nosignatures:
:toctree: generated/

ProtocolDAG
ProtocolUnitResult
ProtocolUnitFailure
ProtocolDAGResult
ProtocolDAG
ProtocolUnitResult
ProtocolUnitFailure
ProtocolDAGResult

Specialised classes
-------------------

These classes are abstract classes that are specialised (subclassed) for an individual Protocol.

.. module:: openfe
:noindex:
:noindex:

.. autosummary::
:nosignatures:
:toctree: generated/
:nosignatures:
:toctree: generated/

Protocol
ProtocolUnit
ProtocolResult
Protocol
ProtocolUnit
ProtocolResult
3 changes: 2 additions & 1 deletion docs/reference/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ OpenFE API Reference
.. toctree::
:maxdepth: 2

alchemical_data_objects
data
systems_and_components
ligand_network
alchemical_network_planning
defining_and_executing_simulations
Expand Down
Loading
Loading