mirror of
https://github.com/OpenFreeEnergy/openfe.git
synced 2026-06-04 14:14:22 +08:00
79ac79d910
* make CLI starting guide easier to find from the landing page * Python API -> API Docs * bump ci * bump example notebooks pin to 2026.01.26 * change a word * clarifying language
26 lines
646 B
ReStructuredText
26 lines
646 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.
|
|
|
|
Python 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_binding_afe
|
|
openmm_septop
|
|
openmm_md
|
|
openmm_protocol_settings
|
|
|
|
.. _gufe: https://gufe.openfree.energy/en/stable/api.html
|