mirror of
https://github.com/OpenFreeEnergy/openfe.git
synced 2026-06-04 22:34:24 +08:00
31bb2a777d
* make gufe lowercase in docs * Update docs/reference/index.rst Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com> * Update docs/reference/api/index.rst Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com> --------- Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
24 lines
604 B
ReStructuredText
24 lines
604 B
ReStructuredText
.. _api:
|
|
|
|
.. note::
|
|
We have reproduced API documentation from the `gufe`_ package here for convenience.
|
|
`gufe`_ serves as a foundation layer for openfe, providing abstract base classes and object models, and so might be more useful for developers.
|
|
|
|
OpenFE API Reference
|
|
====================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
systems_and_components
|
|
atom_mappers
|
|
ligand_network
|
|
alchemical_network_planning
|
|
defining_and_executing_simulations
|
|
openmm_rfe
|
|
openmm_solvation_afe
|
|
openmm_md
|
|
openmm_protocol_settings
|
|
|
|
.. _gufe: https://gufe.readthedocs.io/en/latest/api.html
|