pub_soft/openfe
3
0
Fork 0
mirror of https://github.com/OpenFreeEnergy/openfe.git synced 2026-06-04 14:14:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix links in docs

Browse Source
This commit is contained in:
David W.H. Swenson
2023-05-12 01:42:39 -04:00
committed by Richard Gowers
parent 4e69f2ddab
commit 7e7db849cf
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guide/results/index.rst
View File

@@ -2,5 +2,5 @@ Working with Results
====================
This section is still under construction. In the meantime, please
contact us on our `issue tracker <https://github.com/OpenFreeEnergy/openfe/issues>__`
contact us on our `issue tracker <https://github.com/OpenFreeEnergy/openfe/issues>`_
if you have any questions about analysing your results!

8
docs/tutorials/index.rst
View File

@@ -4,24 +4,24 @@ Tutorials
.. todo: make sure we can inline the tutorial, for now we only provide links
OpenFE has several tutorial notebooks which are maintained on our
`Example Notebooks repository <https://github.com/OpenFreeEnergy/ExampleNotebooks>__`.
`Example Notebooks repository <https://github.com/OpenFreeEnergy/ExampleNotebooks>`_.
For new users, we recommend the following two:
Relative Free Energies CLI tutorial
-----------------------------------
The `Relative Free Energies with the OpenFE CLI <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/easy_campaign/cli-tutorial.md>__`
The `Relative Free Energies with the OpenFE CLI <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/easy_campaign/cli-tutorial.md>`_
tutorial walks users through how to use the OpenFE command line to calculate
relative hydration free energies from a small set of benzene modifications.
Associated with it is also a `notebook <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/easy_campaign/rhfe-python-tutorial.ipynb>__`
Associated with it is also a `notebook <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/easy_campaign/rhfe-python-tutorial.ipynb>`_
for how to achieve the same outcomes using the Python API.
Python API Showcase
-------------------
Our `showcase notebook <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/openmm_rbfe/OpenFE_showcase_1_RBFE_of_T4lysozyme.ipynb>__`
Our `showcase notebook <https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/openmm_rbfe/OpenFE_showcase_1_RBFE_of_T4lysozyme.ipynb>`_
walks users through how to use the main components of OpenFE to create a
relative binding free energy calculation.