Commit Graph

181 Commits

Author SHA1 Message Date
Alyssa Travitz
2ecb01dd2d CLI interface IS redundant 2024-11-12 11:10:21 -08:00
Alyssa Travitz
69f2d0b25b capitalize YAML 2024-10-18 11:24:17 -07:00
Alyssa Travitz
bbc535f14d moving Kartograf link) 2024-10-16 08:43:35 -07:00
Alyssa Travitz
24ef319523 clarity edits to cli_yaml docs 2024-10-16 08:23:09 -07:00
Alyssa Travitz
15394414e2 formatting fixes to cli_basics 2024-10-16 07:44:19 -07:00
Mike Henry
e50102e9a9 add guide on how to set the loglevel to debug 2024-06-19 04:16:19 -07:00
Richard Gowers
3b76941b61 Merge pull request #830 from OpenFreeEnergy/issue_803_userguide_result_networks
docs: first pass at working with networks page
2024-04-19 12:01:03 +01:00
Richard Gowers
581525b9c2 Apply suggestions from code review
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
2024-04-19 11:26:41 +01:00
richard gowers
c18a18a8f9 docs: result network, couple of review comments 2024-04-18 15:37:37 +01:00
Richard Gowers
ad85755fcf Apply suggestions from code review
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
2024-04-18 14:54:23 +01:00
richard gowers
6398f0e452 docs: first pass at working with networks page
fixes issue #803
2024-04-18 10:59:15 +01:00
Richard Gowers
c6d1835634 Update chemical_systems_and_thermodynamic_cycles.rst 2024-04-16 17:02:08 +01:00
richard gowers
b50eb51211 docs: chemical system docs review comments 2024-04-16 14:04:32 +01:00
Richard Gowers
7a538ecf5f Apply suggestions from code review
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
2024-04-16 14:00:40 +01:00
richard gowers
53f8e297c5 docs: fixup reference to chemical systems docs 2024-04-15 12:26:10 +01:00
richard gowers
7c9d6de8a6 docs: add image of RBFE thermo cycle to chemical system docs 2024-04-15 12:26:01 +01:00
richard gowers
8ee14ed0c5 docs: add crossref to chemicalsystems from RBFE protocol docs 2024-04-15 12:25:45 +01:00
Richard Gowers
220d46333b Merge branch 'main' into issue_759_chemical_system 2024-04-15 11:48:06 +01:00
richard gowers
3ed1c55fd8 docs: fixup comment which wasn't commenting itself out
seems to require a blank line
2024-04-15 11:27:19 +01:00
richard gowers
8e3308dafc docs: fix a couple of references
define-rbfe and define-rsfe got merged into a new page

shouldn't use relative links in docs to avoid breaks
2024-04-15 11:04:09 +01:00
Hannah Baumann
82125765a5 Merge branch 'main' into docs_protocol_cycles 2024-04-15 02:08:52 -07:00
hannahbaumann
191e511ae3 Add table steps and outputs plain MD guide 2024-04-15 11:08:31 +02:00
hannahbaumann
0b9a2e5144 Add outputs for the plain MD protocol 2024-04-15 10:53:28 +02:00
hannahbaumann
d5b7aee3fa small fixes 2024-04-15 09:59:23 +02:00
hannahbaumann
41c72ce828 Edit todos 2024-04-15 09:43:37 +02:00
richard gowers
c1d2a2b258 docs: more tweaks following review 2024-04-12 14:52:44 +01:00
Richard Gowers
ab6c254102 Apply suggestions from code review
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
2024-04-12 14:49:04 +01:00
richard gowers
7e41f93582 docs: tweaks following review 2024-04-12 13:01:19 +01:00
richard gowers
679ff03d78 docs: better forward/reverse convergence picture 2024-04-12 12:36:27 +01:00
richard gowers
abf433fe70 docs: check in pictures for RFE analysis section 2024-04-12 11:05:27 +01:00
richard gowers
d3be3f41d9 docs: add example images of analysis
reformat analysis from bullet list to table to have images side by side
2024-04-12 10:40:12 +01:00
richard gowers
b01bfe8fa1 docs: highlight importance of mbar overlap matrix in rbfe docs 2024-04-12 09:31:08 +01:00
Irfan Alibay
3e9b847c1c Update docs/guide/setup/creating_ligand_networks.rst 2024-04-11 12:27:58 +01:00
Benjamin Ries
717778bc70 Update docs/guide/setup/creating_ligand_networks.rst
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
2024-04-11 11:34:24 +02:00
Irfan Alibay
647d8a72cb Merge branch 'main' into docs-ligandNetworks-rework 2024-04-11 07:59:38 +01:00
richard gowers
e778e4fa21 docs: fix links to cookbook nblink entities
this adds a reference anchor in the nbsphinx prolog for each nblink included cookbook

include rfe_alchemical_planners in cookbook list
2024-04-10 17:12:18 +01:00
IAlibay
a92604dc47 Actually copy over the right image 2024-04-10 17:12:18 +01:00
IAlibay
d2d41469d8 switch to Hannah's image for the AlchemicalNetwork 2024-04-10 17:12:18 +01:00
IAlibay
6d0e1c0286 Change cookbook and tutorial links to refs 2024-04-10 17:12:18 +01:00
IAlibay
9cbaa137e5 uncommited stuff 2024-04-10 17:12:18 +01:00
IAlibay
7d3a39f2a9 fix create_alchemical_network cookbook link 2024-04-10 17:12:18 +01:00
IAlibay
c827a67adc fix rbfe_cli_tutorial link 2024-04-10 17:12:18 +01:00
IAlibay
2fc8776598 relative links 2024-04-10 17:12:18 +01:00
IAlibay
60b57eaabd update index 2024-04-10 17:12:18 +01:00
IAlibay
0c5cb0ced0 remove duplicate files and add reference label 2024-04-10 17:12:18 +01:00
IAlibay
e1f571627f add reference label 2024-04-10 17:12:18 +01:00
IAlibay
1eedfb53fe update note 2024-04-10 17:12:18 +01:00
IAlibay
d8c705f2eb Add alchemical network creation userguide page 2024-04-10 17:12:18 +01:00
Irfan Alibay
54347e4cb9 Merge branch 'main' into docs-ligandNetworks-rework 2024-04-10 11:17:59 +01:00
richard gowers
0dd3a73978 docs: final tweaks to userguide quickrun
clarify can run single sim locally

homogenise quickrun examples

add link to working with results page
2024-04-10 09:57:15 +01:00