Skip to content
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
14 changes: 7 additions & 7 deletions docs/guide/execution/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ Both can be used from the command line or from Python.

.. admonition:: Related How-To Guides

* :doc:`/cookbook/dumping_transformation`
* :doc:`/cookbook/run_quickrun`
* :doc:`/cookbook/resume_quickrun`
* :doc:`/cookbook/run_on_slurm`
* :doc:`/cookbook/run_repeats_in_parallel`
* :doc:`/cookbook/run_with_mps`
* :doc:`/cookbook/run_task_based`
* :doc:`/how_to_guides/dumping_transformation`
* :doc:`/how_to_guides/run_quickrun`
* :doc:`/how_to_guides/resume_quickrun`
* :doc:`/how_to_guides/run_on_slurm`
* :doc:`/how_to_guides/run_repeats_in_parallel`
* :doc:`/how_to_guides/run_with_mps`
* :doc:`/how_to_guides/run_task_based`
18 changes: 9 additions & 9 deletions docs/guide/execution/quickrun_execution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ and writes the free energy estimate and its uncertainty to the results file.

quickrun keeps track of which tasks have finished, so an interrupted run can be resumed with ``--resume``.
Finished tasks are skipped, and an interrupted simulation continues from its last checkpoint
(see :doc:`/cookbook/resume_quickrun`).
(see :doc:`/how_to_guides/resume_quickrun`).

Organizing a campaign
---------------------

You decide where and when each Transformation runs, for example by
:doc:`submitting one job per Transformation to a cluster </cookbook/run_on_slurm>`.
:doc:`submitting one job per Transformation to a cluster </how_to_guides/run_on_slurm>`.
You can run multiple simulations in parallel by running several quickrun calls at the same time,
for example one per Transformation, :doc:`one per repeat </cookbook/run_repeats_in_parallel>`,
or :doc:`several on the same GPU </cookbook/run_with_mps>`.
for example one per Transformation, :doc:`one per repeat </how_to_guides/run_repeats_in_parallel>`,
or :doc:`several on the same GPU </how_to_guides/run_with_mps>`.
The results files are then collected with :ref:`openfe gather <cli_gather>`.

.. TODO: link the "Gather free energy results" how-to instead of the CLI reference once it exists.
Expand All @@ -47,11 +47,11 @@ see :ref:`userguide_task_based_execution`.

.. admonition:: How-to guides

* :doc:`/cookbook/run_quickrun`
* :doc:`/cookbook/resume_quickrun`
* :doc:`/cookbook/run_on_slurm`
* :doc:`/cookbook/run_repeats_in_parallel`
* :doc:`/cookbook/run_with_mps`
* :doc:`/how_to_guides/run_quickrun`
* :doc:`/how_to_guides/resume_quickrun`
* :doc:`/how_to_guides/run_on_slurm`
* :doc:`/how_to_guides/run_repeats_in_parallel`
* :doc:`/how_to_guides/run_with_mps`

See Also
--------
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/protocols/absolutebinding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ the `Boresch restraint analysis tutorial
The multistate trajectory (``simulation.nc``) and its topology
(``alchemical_system.pdb``) can be analysed further using `openfe_analysis`_.

.. TODO: Link to the trajectory visualisation cookbook when published.
.. TODO: Link to the trajectory visualisation how_to_guide when published.

See Also
--------
Expand All @@ -154,7 +154,7 @@ See Also

**How-to guides**

:ref:`How-to guides <cookbooks>`
:ref:`How-to guides <how_to_guides>`

**API Documentation**

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/protocols/absolutesolvation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ the structural analysis is skipped. The multistate trajectories
(``solvent.nc`` and ``vacuum.nc``) can be analysed further using
`openfe_analysis`_.

.. TODO: Link to the trajectory visualisation cookbook when published.
.. TODO: Link to the trajectory visualisation how_to_guide when published.


See Also
Expand All @@ -135,7 +135,7 @@ See Also

**How-to guides**

:ref:`How-to guides <cookbooks>`
:ref:`How-to guides <how_to_guides>`

**API Documentation**

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/protocols/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ These limitations apply to all binding free energy protocols.
See also
--------

* :doc:`Choose and configure a protocol </cookbook/choose_protocol>`
* :doc:`Choose and configure a protocol </how_to_guides/choose_protocol>`
* :ref:`Assessing simulation health <userguide_simulation_health>`
* :doc:`Troubleshooting simulations </guide/troubleshooting>`

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/protocols/relativehybridtopology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ evidence of ligand displacement.
The multistate trajectory (``simulation.nc``) and the hybrid topology
(``hybrid_system.pdb``) can be analysed further using `openfe_analysis`_.

.. TODO: Link to the trajectory visualisation cookbook when published.
.. TODO: Link to the trajectory visualisation how_to_guide when published.


See Also
Expand All @@ -219,7 +219,7 @@ See Also

**How-to guides**

:ref:`How-to guides <cookbooks>`
:ref:`How-to guides <how_to_guides>`

**API Documentation**

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/protocols/septop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ the `Boresch restraint analysis tutorial
The multistate trajectory (``simulation.nc``) and its topology
(``alchemical_system.pdb``) can be analysed further using `openfe_analysis`_.

.. TODO: Link to the trajectory visualisation cookbook when published.
.. TODO: Link to the trajectory visualisation how_to_guide when published.

See Also
--------
Expand All @@ -165,7 +165,7 @@ See Also

**How-to guides**

:ref:`How-to guides <cookbooks>`
:ref:`How-to guides <how_to_guides>`

**API Documentation**

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/results/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and entire networks of results analysed.

.. admonition:: How-to guides

* :doc:`/cookbook/dumping_transformation`
* :doc:`/cookbook/jq_inspection`
* :doc:`/how_to_guides/dumping_transformation`
* :doc:`/how_to_guides/jq_inspection`

.. TODO: add the gather, load results, cinnabar and openfe_analysis how-tos.
2 changes: 1 addition & 1 deletion docs/guide/results/simulation_health.rst
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ Some problems only show up across a network. Relative free energies around a
cycle should sum to zero within their uncertainties, and each edge should
agree with the value implied by the rest of the network. Large deviations
point to unreliable edges worth checking with the diagnostics above. These checks need a network with redundant edges
(see :doc:`Generate ligand networks </cookbook/generate_ligand_network>`).
(see :doc:`Generate ligand networks </how_to_guides/generate_ligand_network>`).
To calculate cycle closure errors, see the `cinnabar cycle closure tutorial
<https://cinnabar.openfree.energy/en/latest/tutorials/cycle-closure.html>`_.

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/setup/alchemical_network_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ is often done through a :class:`.LigandNetwork`.

You can manually create a :class:`.AlchemicalNetwork` by creating a list
of :class:`.Transformation` objects. For examples using the Python API,
see :ref:`cookbook on creating alchemical networks <cookbook/create_alchemical_network.nblink>`.
see :ref:`How-to guide on creating alchemical networks <how_to_guides/create_alchemical_network.nblink>`.

2. Python ``NetworkPlanner`` Convenience Classes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

OpenFE also provides the convenience classes :class:`.RBFEAlchemicalNetworkPlanner` and :class:`.RHFEAlchemicalNetworkPlanner`,
which use the :class:`.RelativeHybridTopologyProtocol` for creating :class:`.AlchemicalNetwork`\s.
For example usage of these convenience classes, see :ref:`Relative Alchemical Network Planners cookbook <cookbook/rfe_alchemical_planners.nblink>`.
For example usage of these convenience classes, see :ref:`Relative Alchemical Network Planners How-to guide <how_to_guides/rfe_alchemical_planners.nblink>`.

.. note::
The Network Planners are provided for user convenience. While they cover
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/setup/creating_ligand_networks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Generating Ligand Networks
# plan the ligand network
ligand_network = network_planner(ligands=mols, mappers=[mapper], scorer=scorer)

Practical information on generating ligand networks can be found in our :ref:`cookbook for ligand network generation <cookbook/generate_ligand_network.nblink>`.
Practical information on generating ligand networks can be found in our :ref:`How-to guide for ligand network generation <how_to_guides/generate_ligand_network.nblink>`.

.. note::
Like the Component objects, a ``LigandNetwork`` object is immutable once created!
22 changes: 11 additions & 11 deletions docs/guide/setup/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,22 @@ See :ref:`dumping transformations <dumping_transformations>` for more details.

**Setup**

* :doc:`/cookbook/loading_molecules`
* :doc:`/cookbook/user_charges`
* :doc:`/cookbook/bespoke_parameters`
* :doc:`/how_to_guides/loading_molecules`
* :doc:`/how_to_guides/user_charges`
* :doc:`/how_to_guides/bespoke_parameters`

**Planning: Ligand networks**

* :doc:`/cookbook/generate_ligand_network`
* :doc:`/cookbook/hand_write_ligand_network`
* :doc:`/cookbook/network_from_orion_fepp`
* :doc:`/cookbook/ligandnetwork_vis`
* :doc:`/cookbook/repairing_broken_networks`
* :doc:`/how_to_guides/generate_ligand_network`
* :doc:`/how_to_guides/hand_write_ligand_network`
* :doc:`/how_to_guides/network_from_orion_fepp`
* :doc:`/how_to_guides/ligandnetwork_vis`
* :doc:`/how_to_guides/repairing_broken_networks`

**Planning: Protocols and alchemical networks**

* :doc:`/cookbook/choose_protocol`
* :doc:`/cookbook/rfe_alchemical_planners`
* :doc:`/cookbook/create_alchemical_network`
* :doc:`/how_to_guides/choose_protocol`
* :doc:`/how_to_guides/rfe_alchemical_planners`
* :doc:`/how_to_guides/create_alchemical_network`

.. TODO: add the new Setup and Planning how-tos to this box as they are added.
6 changes: 3 additions & 3 deletions docs/guide/setup/input_preparation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The inputs are loaded as follows:
* **Pre-solvated systems:** ``SolvatedPDBComponent.from_pdb_file`` or
``ProteinMembraneComponent.from_pdb_file``.

See :doc:`Loading Molecules and Chemical Systems </cookbook/loading_molecules>` for examples.
See :doc:`Loading Molecules and Chemical Systems </how_to_guides/loading_molecules>` for examples.

.. _prep_protein:

Expand Down Expand Up @@ -180,7 +180,7 @@ results.

Partial charges are assigned during protocol setup but can also
be assigned in advance for reproducibility and to avoid repeated calculations.
See :doc:`Assigning partial charges </cookbook/user_charges>` (Python API) or
See :doc:`Assigning partial charges </how_to_guides/user_charges>` (Python API) or
:doc:`Generating Partial Charges with the OpenFE CLI </tutorials/charge_molecules_cli_tutorial>`.

.. rubric:: Binding poses
Expand Down Expand Up @@ -225,7 +225,7 @@ Checklist for preparing input ``Components``
See also
--------

* :doc:`Loading Molecules and Chemical Systems </cookbook/loading_molecules>`
* :doc:`Loading Molecules and Chemical Systems </how_to_guides/loading_molecules>`
* :doc:`Components, Chemical Systems and Thermodynamic Cycles <chemical_systems_and_thermodynamic_cycles>`
* :doc:`Membrane RBFE tutorial </tutorials/rbfe_membrane_protein>`
* :ref:`Protocols and domain of applicability <userguide_protocols>`
2 changes: 1 addition & 1 deletion docs/cookbook/index.rst → docs/how_to_guides/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cookbooks:
.. _how_to_guides:

How-To Guides
=============
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The **OpenFE** ecosystem is a free and open-source framework for planning, runni
installation
guide/index
tutorials/index
cookbook/index
how_to_guides/index
reference/index
CHANGELOG

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Post-Simulation Analysis
Generating Partial Charges
--------------------------

.. todo: this should be in cookbook
.. todo: this should be in how_to_guides

- :ref:`Generating Partial Charges CLI tutorial <charge_molecules_cli_tutorial>`: how to use the CLI to assign and store partial charges for mall molecules which can be used throughout the OpenFE ecosystem.

Expand Down
Loading