caddforge-docs 0.3.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. caddforge_docs/__init__.py +1 -0
  2. caddforge_docs/cli.py +20 -0
  3. caddforge_docs/server.py +124 -0
  4. caddforge_docs/site/404.html +2118 -0
  5. caddforge_docs/site/assets/_mkdocstrings.css +237 -0
  6. caddforge_docs/site/assets/images/favicon.png +0 -0
  7. caddforge_docs/site/assets/javascripts/bundle.d7400e89.min.js +16 -0
  8. caddforge_docs/site/assets/javascripts/bundle.d7400e89.min.js.map +7 -0
  9. caddforge_docs/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
  10. caddforge_docs/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
  11. caddforge_docs/site/assets/licenses/W3C-Software-and-Document-2015.txt +15 -0
  12. caddforge_docs/site/assets/licenses/autogrid-COPYING-GPL-2.txt +339 -0
  13. caddforge_docs/site/assets/licenses/autogrid-GCC-RUNTIME-COPYING-GPL-3.txt +674 -0
  14. caddforge_docs/site/assets/licenses/autogrid-GCC-RUNTIME-EXCEPTION.txt +73 -0
  15. caddforge_docs/site/assets/licenses/autogrid-GCC-RUNTIME-NOTICE.txt +24 -0
  16. caddforge_docs/site/assets/licenses/caddforge-opencosmors-COPYING.txt +674 -0
  17. caddforge_docs/site/assets/licenses/caddforge-opencosmors-LICENSE.txt +165 -0
  18. caddforge_docs/site/assets/licenses/caddforge-unidock-tools-LICENSE.txt +202 -0
  19. caddforge_docs/site/assets/licenses/clipboard-LICENSE.txt +19 -0
  20. caddforge_docs/site/assets/licenses/escape-html-LICENSE.txt +2 -0
  21. caddforge_docs/site/assets/licenses/focus-visible-LICENSE.txt +4 -0
  22. caddforge_docs/site/assets/licenses/fontawesome-LICENSE.txt +165 -0
  23. caddforge_docs/site/assets/licenses/fuzzaldrin-plus-LICENSE.txt +21 -0
  24. caddforge_docs/site/assets/licenses/lunr-LICENSE.txt +17 -0
  25. caddforge_docs/site/assets/licenses/material-LICENSE.txt +20 -0
  26. caddforge_docs/site/assets/licenses/material-design-color-LICENSE.txt +31 -0
  27. caddforge_docs/site/assets/licenses/material-shadows-LICENSE.txt +31 -0
  28. caddforge_docs/site/assets/licenses/mkdocs-material-LICENSE.txt +19 -0
  29. caddforge_docs/site/assets/licenses/mkdocs-material-extensions-LICENSE.txt +21 -0
  30. caddforge_docs/site/assets/licenses/mkdocs-section-index-LICENSE.txt +21 -0
  31. caddforge_docs/site/assets/licenses/mkdocstrings-LICENSE.txt +15 -0
  32. caddforge_docs/site/assets/licenses/mkdocstrings-python-LICENSE.txt +15 -0
  33. caddforge_docs/site/assets/licenses/octicons-LICENSE.txt +21 -0
  34. caddforge_docs/site/assets/licenses/preact-LICENSE.txt +19 -0
  35. caddforge_docs/site/assets/licenses/properdocs-LICENSE.txt +26 -0
  36. caddforge_docs/site/assets/licenses/pymdown-extensions-LICENSE.txt +113 -0
  37. caddforge_docs/site/assets/licenses/rxjs-LICENSE.txt +180 -0
  38. caddforge_docs/site/assets/licenses/simple-LICENSE.txt +30 -0
  39. caddforge_docs/site/assets/licenses/tiny-emitter-LICENSE.txt +19 -0
  40. caddforge_docs/site/assets/licenses/tslib-LICENSE.txt +12 -0
  41. caddforge_docs/site/assets/licenses/zeno-rocha-components-LICENSE.txt +22 -0
  42. caddforge_docs/site/assets/stylesheets/main.ec1eaa64.min.css +1 -0
  43. caddforge_docs/site/assets/stylesheets/main.ec1eaa64.min.css.map +1 -0
  44. caddforge_docs/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
  45. caddforge_docs/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
  46. caddforge_docs/site/core/cli/index.html +2446 -0
  47. caddforge_docs/site/core/concepts/index.html +2340 -0
  48. caddforge_docs/site/core/configuration/index.html +2300 -0
  49. caddforge_docs/site/core/index.html +2170 -0
  50. caddforge_docs/site/core/jobs-results/index.html +2315 -0
  51. caddforge_docs/site/core/plugins/index.html +2200 -0
  52. caddforge_docs/site/core/slurm/index.html +2562 -0
  53. caddforge_docs/site/development/ci-publishing/index.html +2345 -0
  54. caddforge_docs/site/development/contributing/index.html +2311 -0
  55. caddforge_docs/site/development/documentation/index.html +2380 -0
  56. caddforge_docs/site/development/index.html +2201 -0
  57. caddforge_docs/site/development/release-notes/index.html +2504 -0
  58. caddforge_docs/site/development/release-readiness/index.html +2333 -0
  59. caddforge_docs/site/development/security/index.html +2181 -0
  60. caddforge_docs/site/development/tool-authoring/index.html +2435 -0
  61. caddforge_docs/site/examples/index.html +2465 -0
  62. caddforge_docs/site/examples/manifest.json +158 -0
  63. caddforge_docs/site/examples/minimize/component_overrides.yaml +14 -0
  64. caddforge_docs/site/examples/minimize/ligand_only.yaml +13 -0
  65. caddforge_docs/site/examples/minimize/pipeline_docking.yaml +84 -0
  66. caddforge_docs/site/examples/minimize/pipeline_scatter.yaml +49 -0
  67. caddforge_docs/site/examples/minimize/pocket_free_shell_restrained.yaml +13 -0
  68. caddforge_docs/site/examples/minimize/pocket_restrained.yaml +13 -0
  69. caddforge_docs/site/examples/minimize/prepared_metal.yaml +14 -0
  70. caddforge_docs/site/examples/minimize/sidechains_free_backbone_fixed.yaml +13 -0
  71. caddforge_docs/site/examples/minimize/sidechains_free_backbone_restrained.yaml +13 -0
  72. caddforge_docs/site/examples/pipelines/descriptor-model-and-candidate-filter.yaml +44 -0
  73. caddforge_docs/site/examples/pipelines/dock-extract-and-minimize-poses.yaml +85 -0
  74. caddforge_docs/site/examples/pipelines/docking-screen-and-rescore.yaml +55 -0
  75. caddforge_docs/site/examples/pipelines/flexible-gnina-to-openbpmd-to-md-to-abfe.yaml +189 -0
  76. caddforge_docs/site/examples/pipelines/gnina-flexible-complex-artifacts.yaml +52 -0
  77. caddforge_docs/site/examples/pipelines/minimize-a-multi-pose-sdf.yaml +46 -0
  78. caddforge_docs/site/examples/pipelines/pose-level-md-selection.yaml +95 -0
  79. caddforge_docs/site/examples/pipelines/result-collection-and-diagnostics.yaml +55 -0
  80. caddforge_docs/site/examples/quickstart/diagnostics.yaml +8 -0
  81. caddforge_docs/site/examples/quickstart/index.html +2172 -0
  82. caddforge_docs/site/examples/quickstart/pipeline.yaml +23 -0
  83. caddforge_docs/site/examples/quickstart/run.py +18 -0
  84. caddforge_docs/site/examples/quickstart/run_pipeline.py +6 -0
  85. caddforge_docs/site/examples/quickstart/scores.csv +7 -0
  86. caddforge_docs/site/examples/quickstart/values.csv +31 -0
  87. caddforge_docs/site/examples/run_tool.py +40 -0
  88. caddforge_docs/site/examples/tools/datascience-csv-scatter.yaml +17 -0
  89. caddforge_docs/site/examples/tools/datascience-distribution-diagnostics.yaml +10 -0
  90. caddforge_docs/site/examples/tools/descriptors-ani-conformers.yaml +9 -0
  91. caddforge_docs/site/examples/tools/descriptors-ani-psa.yaml +9 -0
  92. caddforge_docs/site/examples/tools/descriptors-cluster-molecules.yaml +11 -0
  93. caddforge_docs/site/examples/tools/descriptors-phesa.yaml +7 -0
  94. caddforge_docs/site/examples/tools/docking-gnina.yaml +12 -0
  95. caddforge_docs/site/examples/tools/docking-idockya.yaml +8 -0
  96. caddforge_docs/site/examples/tools/docking-unidock.yaml +12 -0
  97. caddforge_docs/site/examples/tools/fep-openfe-abfe.yaml +53 -0
  98. caddforge_docs/site/examples/tools/fep-openfe-rbfe-septop.yaml +23 -0
  99. caddforge_docs/site/examples/tools/md-center-and-align.yaml +16 -0
  100. caddforge_docs/site/examples/tools/md-cluster-representative.yaml +16 -0
  101. caddforge_docs/site/examples/tools/md-extract-frames.yaml +17 -0
  102. caddforge_docs/site/examples/tools/md-fix-structure.yaml +20 -0
  103. caddforge_docs/site/examples/tools/md-grand.yaml +28 -0
  104. caddforge_docs/site/examples/tools/md-inducia.yaml +29 -0
  105. caddforge_docs/site/examples/tools/md-minimize.yaml +13 -0
  106. caddforge_docs/site/examples/tools/md-openbpmd.yaml +11 -0
  107. caddforge_docs/site/examples/tools/md-plain-md.yaml +28 -0
  108. caddforge_docs/site/examples/tools/ml-explore-classifier.yaml +5 -0
  109. caddforge_docs/site/examples/tools/ml-model-factory.yaml +32 -0
  110. caddforge_docs/site/examples/tools/ml-model-zoo.yaml +16 -0
  111. caddforge_docs/site/examples/tools/ml-pca.yaml +10 -0
  112. caddforge_docs/site/examples/tools/ml-simple-gp.yaml +17 -0
  113. caddforge_docs/site/examples/tools/qm-transfer-free-energy.yaml +11 -0
  114. caddforge_docs/site/explanation/references/index.html +2218 -0
  115. caddforge_docs/site/explanation/reproducibility/index.html +2306 -0
  116. caddforge_docs/site/explanation/third-party-notices/index.html +2599 -0
  117. caddforge_docs/site/getting-started/first-pipeline/index.html +2195 -0
  118. caddforge_docs/site/getting-started/first-workflow/index.html +2329 -0
  119. caddforge_docs/site/getting-started/index.html +2200 -0
  120. caddforge_docs/site/getting-started/installation/index.html +2541 -0
  121. caddforge_docs/site/gui/index.html +2267 -0
  122. caddforge_docs/site/gui/plugin-authoring/index.html +2280 -0
  123. caddforge_docs/site/gui/walkthrough/index.html +2181 -0
  124. caddforge_docs/site/how-to/jobs/index.html +2195 -0
  125. caddforge_docs/site/how-to/scatter/index.html +2193 -0
  126. caddforge_docs/site/how-to/troubleshooting/index.html +2429 -0
  127. caddforge_docs/site/index.html +2359 -0
  128. caddforge_docs/site/objects.inv +0 -0
  129. caddforge_docs/site/pipelines/artifacts/index.html +2314 -0
  130. caddforge_docs/site/pipelines/built-ins/index.html +2670 -0
  131. caddforge_docs/site/pipelines/examples/index.html +3186 -0
  132. caddforge_docs/site/pipelines/index.html +2164 -0
  133. caddforge_docs/site/pipelines/specification/index.html +2278 -0
  134. caddforge_docs/site/plugins/datascience/index.html +2405 -0
  135. caddforge_docs/site/plugins/descriptors/index.html +2609 -0
  136. caddforge_docs/site/plugins/docking/index.html +2480 -0
  137. caddforge_docs/site/plugins/fep/index.html +2508 -0
  138. caddforge_docs/site/plugins/index.html +2216 -0
  139. caddforge_docs/site/plugins/md/index.html +3795 -0
  140. caddforge_docs/site/plugins/ml/index.html +2815 -0
  141. caddforge_docs/site/plugins/qm/index.html +2309 -0
  142. caddforge_docs/site/plugins/version-matrix/index.html +2449 -0
  143. caddforge_docs/site/reference/api/index.html +4414 -0
  144. caddforge_docs/site/reference/index.html +2166 -0
  145. caddforge_docs/site/search/search_index.json +1 -0
  146. caddforge_docs/site/sitemap.xml +191 -0
  147. caddforge_docs/site/sitemap.xml.gz +0 -0
  148. caddforge_docs-0.3.0.dist-info/METADATA +158 -0
  149. caddforge_docs-0.3.0.dist-info/RECORD +152 -0
  150. caddforge_docs-0.3.0.dist-info/WHEEL +4 -0
  151. caddforge_docs-0.3.0.dist-info/entry_points.txt +2 -0
  152. caddforge_docs-0.3.0.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,2340 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+ <meta name="description" content="Central documentation for the CADDForge CADD toolbox framework.">
10
+
11
+
12
+
13
+ <link rel="canonical" href="https://idorsia.github.io/caddforge-docs/core/concepts/">
14
+
15
+
16
+ <link rel="prev" href="../">
17
+
18
+
19
+ <link rel="next" href="../configuration/">
20
+
21
+
22
+
23
+
24
+
25
+ <link rel="icon" href="../../assets/images/favicon.png">
26
+ <meta name="generator" content="mkdocs-ProperDocs 1.6.7, mkdocs-material-9.7.7">
27
+
28
+
29
+
30
+ <title>Concepts - CADDForge</title>
31
+
32
+
33
+
34
+ <link rel="stylesheet" href="../../assets/stylesheets/main.ec1eaa64.min.css">
35
+
36
+
37
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+ <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
51
+
52
+ <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
53
+
54
+
55
+
56
+
57
+
58
+ </head>
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="teal">
69
+
70
+
71
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
72
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
73
+ <label class="md-overlay" for="__drawer"></label>
74
+ <div data-md-component="skip">
75
+
76
+
77
+ <a href="#concepts" class="md-skip">
78
+ Skip to content
79
+ </a>
80
+
81
+ </div>
82
+ <div data-md-component="announce">
83
+
84
+ </div>
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <header class="md-header md-header--shadow" data-md-component="header">
92
+ <nav class="md-header__inner md-grid" aria-label="Header">
93
+ <a href="../.." title="CADDForge" class="md-header__button md-logo" aria-label="CADDForge" data-md-component="logo">
94
+
95
+
96
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
97
+
98
+ </a>
99
+ <label class="md-header__button md-icon" for="__drawer">
100
+
101
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
102
+ </label>
103
+ <div class="md-header__title" data-md-component="header-title">
104
+ <div class="md-header__ellipsis">
105
+ <div class="md-header__topic">
106
+ <span class="md-ellipsis">
107
+ CADDForge
108
+ </span>
109
+ </div>
110
+ <div class="md-header__topic" data-md-component="header-topic">
111
+ <span class="md-ellipsis">
112
+
113
+ Concepts
114
+
115
+ </span>
116
+ </div>
117
+ </div>
118
+ </div>
119
+
120
+
121
+ <form class="md-header__option" data-md-component="palette">
122
+
123
+
124
+
125
+
126
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="teal" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
127
+
128
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
129
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
130
+ </label>
131
+
132
+
133
+
134
+
135
+
136
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue" data-md-color-accent="teal" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
137
+
138
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
139
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
140
+ </label>
141
+
142
+
143
+ </form>
144
+
145
+
146
+
147
+ <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
148
+
149
+
150
+
151
+
152
+
153
+ <label class="md-header__button md-icon" for="__search">
154
+
155
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
156
+ </label>
157
+ <div class="md-search" data-md-component="search" role="dialog">
158
+ <label class="md-search__overlay" for="__search"></label>
159
+ <div class="md-search__inner" role="search">
160
+ <form class="md-search__form" name="search">
161
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
162
+ <label class="md-search__icon md-icon" for="__search">
163
+
164
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
165
+
166
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
167
+ </label>
168
+ <nav class="md-search__options" aria-label="Search">
169
+
170
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
171
+
172
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
173
+ </button>
174
+ </nav>
175
+
176
+ <div class="md-search__suggest" data-md-component="search-suggest"></div>
177
+
178
+ </form>
179
+ <div class="md-search__output">
180
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
181
+ <div class="md-search-result" data-md-component="search-result">
182
+ <div class="md-search-result__meta">
183
+ Initializing search
184
+ </div>
185
+ <ol class="md-search-result__list" role="presentation"></ol>
186
+ </div>
187
+ </div>
188
+ </div>
189
+ </div>
190
+ </div>
191
+
192
+
193
+
194
+ <div class="md-header__source">
195
+ <a href="https://github.com/idorsia/caddforge-docs" title="Go to repository" class="md-source" data-md-component="source">
196
+ <div class="md-source__icon md-icon">
197
+
198
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
199
+ </div>
200
+ <div class="md-source__repository">
201
+ caddforge-docs
202
+ </div>
203
+ </a>
204
+ </div>
205
+
206
+ </nav>
207
+
208
+ </header>
209
+
210
+ <div class="md-container" data-md-component="container">
211
+
212
+
213
+
214
+
215
+
216
+
217
+ <main class="md-main" data-md-component="main">
218
+ <div class="md-main__inner md-grid">
219
+
220
+
221
+
222
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
223
+ <div class="md-sidebar__scrollwrap">
224
+ <div class="md-sidebar__inner">
225
+
226
+
227
+
228
+
229
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
230
+ <label class="md-nav__title" for="__drawer">
231
+ <a href="../.." title="CADDForge" class="md-nav__button md-logo" aria-label="CADDForge" data-md-component="logo">
232
+
233
+
234
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
235
+
236
+ </a>
237
+ CADDForge
238
+ </label>
239
+
240
+ <div class="md-nav__source">
241
+ <a href="https://github.com/idorsia/caddforge-docs" title="Go to repository" class="md-source" data-md-component="source">
242
+ <div class="md-source__icon md-icon">
243
+
244
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
245
+ </div>
246
+ <div class="md-source__repository">
247
+ caddforge-docs
248
+ </div>
249
+ </a>
250
+ </div>
251
+
252
+ <ul class="md-nav__list" data-md-scrollfix>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ <li class="md-nav__item">
261
+ <a href="../.." class="md-nav__link">
262
+
263
+
264
+
265
+ <span class="md-ellipsis">
266
+
267
+
268
+ Home
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+ </a>
277
+ </li>
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
306
+
307
+
308
+
309
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
310
+
311
+
312
+ <div class="md-nav__link md-nav__container">
313
+ <a href="../../getting-started/" class="md-nav__link ">
314
+
315
+
316
+
317
+ <span class="md-ellipsis">
318
+
319
+
320
+ Getting Started
321
+
322
+
323
+
324
+ </span>
325
+
326
+
327
+
328
+ </a>
329
+
330
+
331
+ <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
332
+ <span class="md-nav__icon md-icon"></span>
333
+ </label>
334
+
335
+ </div>
336
+
337
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
338
+ <label class="md-nav__title" for="__nav_2">
339
+ <span class="md-nav__icon md-icon"></span>
340
+
341
+
342
+ Getting Started
343
+
344
+
345
+ </label>
346
+ <ul class="md-nav__list" data-md-scrollfix>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <li class="md-nav__item">
355
+ <a href="../../getting-started/installation/" class="md-nav__link">
356
+
357
+
358
+
359
+ <span class="md-ellipsis">
360
+
361
+
362
+ Installation
363
+
364
+
365
+
366
+ </span>
367
+
368
+
369
+
370
+ </a>
371
+ </li>
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+ <li class="md-nav__item">
383
+ <a href="../../getting-started/first-workflow/" class="md-nav__link">
384
+
385
+
386
+
387
+ <span class="md-ellipsis">
388
+
389
+
390
+ First Workflow
391
+
392
+
393
+
394
+ </span>
395
+
396
+
397
+
398
+ </a>
399
+ </li>
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+ <li class="md-nav__item">
411
+ <a href="../../getting-started/first-pipeline/" class="md-nav__link">
412
+
413
+
414
+
415
+ <span class="md-ellipsis">
416
+
417
+
418
+ First Pipeline
419
+
420
+
421
+
422
+ </span>
423
+
424
+
425
+
426
+ </a>
427
+ </li>
428
+
429
+
430
+
431
+
432
+ </ul>
433
+ </nav>
434
+
435
+ </li>
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
464
+
465
+
466
+
467
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
468
+
469
+
470
+ <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
471
+
472
+
473
+
474
+ <span class="md-ellipsis">
475
+
476
+
477
+ How-to Guides
478
+
479
+
480
+
481
+ </span>
482
+
483
+
484
+
485
+ <span class="md-nav__icon md-icon"></span>
486
+ </label>
487
+
488
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
489
+ <label class="md-nav__title" for="__nav_3">
490
+ <span class="md-nav__icon md-icon"></span>
491
+
492
+
493
+ How-to Guides
494
+
495
+
496
+ </label>
497
+ <ul class="md-nav__list" data-md-scrollfix>
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+ <li class="md-nav__item">
506
+ <a href="../../how-to/jobs/" class="md-nav__link">
507
+
508
+
509
+
510
+ <span class="md-ellipsis">
511
+
512
+
513
+ Jobs and Results
514
+
515
+
516
+
517
+ </span>
518
+
519
+
520
+
521
+ </a>
522
+ </li>
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+ <li class="md-nav__item">
534
+ <a href="../../how-to/scatter/" class="md-nav__link">
535
+
536
+
537
+
538
+ <span class="md-ellipsis">
539
+
540
+
541
+ Scatter and Reduce
542
+
543
+
544
+
545
+ </span>
546
+
547
+
548
+
549
+ </a>
550
+ </li>
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+ <li class="md-nav__item">
562
+ <a href="../../how-to/troubleshooting/" class="md-nav__link">
563
+
564
+
565
+
566
+ <span class="md-ellipsis">
567
+
568
+
569
+ Troubleshooting
570
+
571
+
572
+
573
+ </span>
574
+
575
+
576
+
577
+ </a>
578
+ </li>
579
+
580
+
581
+
582
+
583
+ </ul>
584
+ </nav>
585
+
586
+ </li>
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+ <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
623
+
624
+
625
+
626
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
627
+
628
+
629
+ <div class="md-nav__link md-nav__container">
630
+ <a href="../" class="md-nav__link ">
631
+
632
+
633
+
634
+ <span class="md-ellipsis">
635
+
636
+
637
+ Core
638
+
639
+
640
+
641
+ </span>
642
+
643
+
644
+
645
+ </a>
646
+
647
+
648
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
649
+ <span class="md-nav__icon md-icon"></span>
650
+ </label>
651
+
652
+ </div>
653
+
654
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
655
+ <label class="md-nav__title" for="__nav_4">
656
+ <span class="md-nav__icon md-icon"></span>
657
+
658
+
659
+ Core
660
+
661
+
662
+ </label>
663
+ <ul class="md-nav__list" data-md-scrollfix>
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+ <li class="md-nav__item md-nav__item--active">
674
+
675
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
676
+
677
+
678
+
679
+
680
+
681
+ <label class="md-nav__link md-nav__link--active" for="__toc">
682
+
683
+
684
+
685
+ <span class="md-ellipsis">
686
+
687
+
688
+ Concepts
689
+
690
+
691
+
692
+ </span>
693
+
694
+
695
+
696
+ <span class="md-nav__icon md-icon"></span>
697
+ </label>
698
+
699
+ <a href="./" class="md-nav__link md-nav__link--active">
700
+
701
+
702
+
703
+ <span class="md-ellipsis">
704
+
705
+
706
+ Concepts
707
+
708
+
709
+
710
+ </span>
711
+
712
+
713
+
714
+ </a>
715
+
716
+
717
+
718
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
719
+
720
+
721
+
722
+
723
+
724
+
725
+ <label class="md-nav__title" for="__toc">
726
+ <span class="md-nav__icon md-icon"></span>
727
+ Table of contents
728
+ </label>
729
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
730
+
731
+ <li class="md-nav__item">
732
+ <a href="#dataset-and-moleculeset" class="md-nav__link">
733
+ <span class="md-ellipsis">
734
+
735
+ Dataset and MoleculeSet
736
+
737
+ </span>
738
+ </a>
739
+
740
+ </li>
741
+
742
+ <li class="md-nav__item">
743
+ <a href="#workflow" class="md-nav__link">
744
+ <span class="md-ellipsis">
745
+
746
+ Workflow
747
+
748
+ </span>
749
+ </a>
750
+
751
+ </li>
752
+
753
+ <li class="md-nav__item">
754
+ <a href="#job" class="md-nav__link">
755
+ <span class="md-ellipsis">
756
+
757
+ Job
758
+
759
+ </span>
760
+ </a>
761
+
762
+ </li>
763
+
764
+ <li class="md-nav__item">
765
+ <a href="#backend" class="md-nav__link">
766
+ <span class="md-ellipsis">
767
+
768
+ Backend
769
+
770
+ </span>
771
+ </a>
772
+
773
+ </li>
774
+
775
+ <li class="md-nav__item">
776
+ <a href="#result" class="md-nav__link">
777
+ <span class="md-ellipsis">
778
+
779
+ Result
780
+
781
+ </span>
782
+ </a>
783
+
784
+ </li>
785
+
786
+ </ul>
787
+
788
+ </nav>
789
+
790
+ </li>
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+ <li class="md-nav__item">
802
+ <a href="../configuration/" class="md-nav__link">
803
+
804
+
805
+
806
+ <span class="md-ellipsis">
807
+
808
+
809
+ Configuration
810
+
811
+
812
+
813
+ </span>
814
+
815
+
816
+
817
+ </a>
818
+ </li>
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+
827
+
828
+
829
+ <li class="md-nav__item">
830
+ <a href="../cli/" class="md-nav__link">
831
+
832
+
833
+
834
+ <span class="md-ellipsis">
835
+
836
+
837
+ CLI
838
+
839
+
840
+
841
+ </span>
842
+
843
+
844
+
845
+ </a>
846
+ </li>
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+
857
+ <li class="md-nav__item">
858
+ <a href="../jobs-results/" class="md-nav__link">
859
+
860
+
861
+
862
+ <span class="md-ellipsis">
863
+
864
+
865
+ Jobs and Results
866
+
867
+
868
+
869
+ </span>
870
+
871
+
872
+
873
+ </a>
874
+ </li>
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+ <li class="md-nav__item">
886
+ <a href="../slurm/" class="md-nav__link">
887
+
888
+
889
+
890
+ <span class="md-ellipsis">
891
+
892
+
893
+ Slurm Backend
894
+
895
+
896
+
897
+ </span>
898
+
899
+
900
+
901
+ </a>
902
+ </li>
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+ <li class="md-nav__item">
914
+ <a href="../plugins/" class="md-nav__link">
915
+
916
+
917
+
918
+ <span class="md-ellipsis">
919
+
920
+
921
+ Plugins
922
+
923
+
924
+
925
+ </span>
926
+
927
+
928
+
929
+ </a>
930
+ </li>
931
+
932
+
933
+
934
+
935
+ </ul>
936
+ </nav>
937
+
938
+ </li>
939
+
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+
964
+
965
+
966
+
967
+
968
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
969
+
970
+
971
+
972
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
973
+
974
+
975
+ <div class="md-nav__link md-nav__container">
976
+ <a href="../../pipelines/" class="md-nav__link ">
977
+
978
+
979
+
980
+ <span class="md-ellipsis">
981
+
982
+
983
+ Pipelines
984
+
985
+
986
+
987
+ </span>
988
+
989
+
990
+
991
+ </a>
992
+
993
+
994
+ <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
995
+ <span class="md-nav__icon md-icon"></span>
996
+ </label>
997
+
998
+ </div>
999
+
1000
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1001
+ <label class="md-nav__title" for="__nav_5">
1002
+ <span class="md-nav__icon md-icon"></span>
1003
+
1004
+
1005
+ Pipelines
1006
+
1007
+
1008
+ </label>
1009
+ <ul class="md-nav__list" data-md-scrollfix>
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+ <li class="md-nav__item">
1018
+ <a href="../../pipelines/specification/" class="md-nav__link">
1019
+
1020
+
1021
+
1022
+ <span class="md-ellipsis">
1023
+
1024
+
1025
+ Specification
1026
+
1027
+
1028
+
1029
+ </span>
1030
+
1031
+
1032
+
1033
+ </a>
1034
+ </li>
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+ <li class="md-nav__item">
1046
+ <a href="../../pipelines/artifacts/" class="md-nav__link">
1047
+
1048
+
1049
+
1050
+ <span class="md-ellipsis">
1051
+
1052
+
1053
+ Artifacts
1054
+
1055
+
1056
+
1057
+ </span>
1058
+
1059
+
1060
+
1061
+ </a>
1062
+ </li>
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+ <li class="md-nav__item">
1074
+ <a href="../../pipelines/built-ins/" class="md-nav__link">
1075
+
1076
+
1077
+
1078
+ <span class="md-ellipsis">
1079
+
1080
+
1081
+ Built-in Stages
1082
+
1083
+
1084
+
1085
+ </span>
1086
+
1087
+
1088
+
1089
+ </a>
1090
+ </li>
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+ <li class="md-nav__item">
1102
+ <a href="../../pipelines/examples/" class="md-nav__link">
1103
+
1104
+
1105
+
1106
+ <span class="md-ellipsis">
1107
+
1108
+
1109
+ Examples
1110
+
1111
+
1112
+
1113
+ </span>
1114
+
1115
+
1116
+
1117
+ </a>
1118
+ </li>
1119
+
1120
+
1121
+
1122
+
1123
+ </ul>
1124
+ </nav>
1125
+
1126
+ </li>
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1165
+
1166
+
1167
+
1168
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1169
+
1170
+
1171
+ <div class="md-nav__link md-nav__container">
1172
+ <a href="../../plugins/" class="md-nav__link ">
1173
+
1174
+
1175
+
1176
+ <span class="md-ellipsis">
1177
+
1178
+
1179
+ Plugins
1180
+
1181
+
1182
+
1183
+ </span>
1184
+
1185
+
1186
+
1187
+ </a>
1188
+
1189
+
1190
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
1191
+ <span class="md-nav__icon md-icon"></span>
1192
+ </label>
1193
+
1194
+ </div>
1195
+
1196
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1197
+ <label class="md-nav__title" for="__nav_6">
1198
+ <span class="md-nav__icon md-icon"></span>
1199
+
1200
+
1201
+ Plugins
1202
+
1203
+
1204
+ </label>
1205
+ <ul class="md-nav__list" data-md-scrollfix>
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+ <li class="md-nav__item">
1214
+ <a href="../../plugins/version-matrix/" class="md-nav__link">
1215
+
1216
+
1217
+
1218
+ <span class="md-ellipsis">
1219
+
1220
+
1221
+ Version Matrix
1222
+
1223
+
1224
+
1225
+ </span>
1226
+
1227
+
1228
+
1229
+ </a>
1230
+ </li>
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+ <li class="md-nav__item">
1242
+ <a href="../../plugins/docking/" class="md-nav__link">
1243
+
1244
+
1245
+
1246
+ <span class="md-ellipsis">
1247
+
1248
+
1249
+ Docking
1250
+
1251
+
1252
+
1253
+ </span>
1254
+
1255
+
1256
+
1257
+ </a>
1258
+ </li>
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+ <li class="md-nav__item">
1270
+ <a href="../../plugins/descriptors/" class="md-nav__link">
1271
+
1272
+
1273
+
1274
+ <span class="md-ellipsis">
1275
+
1276
+
1277
+ Descriptors
1278
+
1279
+
1280
+
1281
+ </span>
1282
+
1283
+
1284
+
1285
+ </a>
1286
+ </li>
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+
1296
+
1297
+ <li class="md-nav__item">
1298
+ <a href="../../plugins/md/" class="md-nav__link">
1299
+
1300
+
1301
+
1302
+ <span class="md-ellipsis">
1303
+
1304
+
1305
+ MD
1306
+
1307
+
1308
+
1309
+ </span>
1310
+
1311
+
1312
+
1313
+ </a>
1314
+ </li>
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+ <li class="md-nav__item">
1326
+ <a href="../../plugins/fep/" class="md-nav__link">
1327
+
1328
+
1329
+
1330
+ <span class="md-ellipsis">
1331
+
1332
+
1333
+ FEP
1334
+
1335
+
1336
+
1337
+ </span>
1338
+
1339
+
1340
+
1341
+ </a>
1342
+ </li>
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+ <li class="md-nav__item">
1354
+ <a href="../../plugins/qm/" class="md-nav__link">
1355
+
1356
+
1357
+
1358
+ <span class="md-ellipsis">
1359
+
1360
+
1361
+ QM
1362
+
1363
+
1364
+
1365
+ </span>
1366
+
1367
+
1368
+
1369
+ </a>
1370
+ </li>
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+ <li class="md-nav__item">
1382
+ <a href="../../plugins/ml/" class="md-nav__link">
1383
+
1384
+
1385
+
1386
+ <span class="md-ellipsis">
1387
+
1388
+
1389
+ ML
1390
+
1391
+
1392
+
1393
+ </span>
1394
+
1395
+
1396
+
1397
+ </a>
1398
+ </li>
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+
1409
+ <li class="md-nav__item">
1410
+ <a href="../../plugins/datascience/" class="md-nav__link">
1411
+
1412
+
1413
+
1414
+ <span class="md-ellipsis">
1415
+
1416
+
1417
+ Data Science
1418
+
1419
+
1420
+
1421
+ </span>
1422
+
1423
+
1424
+
1425
+ </a>
1426
+ </li>
1427
+
1428
+
1429
+
1430
+
1431
+ </ul>
1432
+ </nav>
1433
+
1434
+ </li>
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+
1459
+
1460
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1461
+
1462
+
1463
+
1464
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
1465
+
1466
+
1467
+ <div class="md-nav__link md-nav__container">
1468
+ <a href="../../gui/" class="md-nav__link ">
1469
+
1470
+
1471
+
1472
+ <span class="md-ellipsis">
1473
+
1474
+
1475
+ GUI
1476
+
1477
+
1478
+
1479
+ </span>
1480
+
1481
+
1482
+
1483
+ </a>
1484
+
1485
+
1486
+ <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
1487
+ <span class="md-nav__icon md-icon"></span>
1488
+ </label>
1489
+
1490
+ </div>
1491
+
1492
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1493
+ <label class="md-nav__title" for="__nav_7">
1494
+ <span class="md-nav__icon md-icon"></span>
1495
+
1496
+
1497
+ GUI
1498
+
1499
+
1500
+ </label>
1501
+ <ul class="md-nav__list" data-md-scrollfix>
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+ <li class="md-nav__item">
1510
+ <a href="../../gui/walkthrough/" class="md-nav__link">
1511
+
1512
+
1513
+
1514
+ <span class="md-ellipsis">
1515
+
1516
+
1517
+ Walkthrough
1518
+
1519
+
1520
+
1521
+ </span>
1522
+
1523
+
1524
+
1525
+ </a>
1526
+ </li>
1527
+
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+ <li class="md-nav__item">
1538
+ <a href="../../gui/plugin-authoring/" class="md-nav__link">
1539
+
1540
+
1541
+
1542
+ <span class="md-ellipsis">
1543
+
1544
+
1545
+ Plugin GUI Authoring
1546
+
1547
+
1548
+
1549
+ </span>
1550
+
1551
+
1552
+
1553
+ </a>
1554
+ </li>
1555
+
1556
+
1557
+
1558
+
1559
+ </ul>
1560
+ </nav>
1561
+
1562
+ </li>
1563
+
1564
+
1565
+
1566
+
1567
+
1568
+
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+
1575
+
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1591
+
1592
+
1593
+
1594
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
1595
+
1596
+
1597
+ <div class="md-nav__link md-nav__container">
1598
+ <a href="../../reference/" class="md-nav__link ">
1599
+
1600
+
1601
+
1602
+ <span class="md-ellipsis">
1603
+
1604
+
1605
+ Reference
1606
+
1607
+
1608
+
1609
+ </span>
1610
+
1611
+
1612
+
1613
+ </a>
1614
+
1615
+
1616
+ <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
1617
+ <span class="md-nav__icon md-icon"></span>
1618
+ </label>
1619
+
1620
+ </div>
1621
+
1622
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
1623
+ <label class="md-nav__title" for="__nav_8">
1624
+ <span class="md-nav__icon md-icon"></span>
1625
+
1626
+
1627
+ Reference
1628
+
1629
+
1630
+ </label>
1631
+ <ul class="md-nav__list" data-md-scrollfix>
1632
+
1633
+
1634
+
1635
+
1636
+
1637
+
1638
+
1639
+ <li class="md-nav__item">
1640
+ <a href="../../reference/api/" class="md-nav__link">
1641
+
1642
+
1643
+
1644
+ <span class="md-ellipsis">
1645
+
1646
+
1647
+ Public Python API
1648
+
1649
+
1650
+
1651
+ </span>
1652
+
1653
+
1654
+
1655
+ </a>
1656
+ </li>
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+ <li class="md-nav__item">
1668
+ <a href="../../examples/" class="md-nav__link">
1669
+
1670
+
1671
+
1672
+ <span class="md-ellipsis">
1673
+
1674
+
1675
+ Example Library
1676
+
1677
+
1678
+
1679
+ </span>
1680
+
1681
+
1682
+
1683
+ </a>
1684
+ </li>
1685
+
1686
+
1687
+
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+
1695
+ <li class="md-nav__item">
1696
+ <a href="../../examples/quickstart/" class="md-nav__link">
1697
+
1698
+
1699
+
1700
+ <span class="md-ellipsis">
1701
+
1702
+
1703
+ Example Data Provenance
1704
+
1705
+
1706
+
1707
+ </span>
1708
+
1709
+
1710
+
1711
+ </a>
1712
+ </li>
1713
+
1714
+
1715
+
1716
+
1717
+ </ul>
1718
+ </nav>
1719
+
1720
+ </li>
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+
1744
+
1745
+
1746
+
1747
+
1748
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1749
+
1750
+
1751
+
1752
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
1753
+
1754
+
1755
+ <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
1756
+
1757
+
1758
+
1759
+ <span class="md-ellipsis">
1760
+
1761
+
1762
+ Explanation
1763
+
1764
+
1765
+
1766
+ </span>
1767
+
1768
+
1769
+
1770
+ <span class="md-nav__icon md-icon"></span>
1771
+ </label>
1772
+
1773
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
1774
+ <label class="md-nav__title" for="__nav_9">
1775
+ <span class="md-nav__icon md-icon"></span>
1776
+
1777
+
1778
+ Explanation
1779
+
1780
+
1781
+ </label>
1782
+ <ul class="md-nav__list" data-md-scrollfix>
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+ <li class="md-nav__item">
1791
+ <a href="../../explanation/reproducibility/" class="md-nav__link">
1792
+
1793
+
1794
+
1795
+ <span class="md-ellipsis">
1796
+
1797
+
1798
+ Reproducibility
1799
+
1800
+
1801
+
1802
+ </span>
1803
+
1804
+
1805
+
1806
+ </a>
1807
+ </li>
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+
1815
+
1816
+
1817
+
1818
+ <li class="md-nav__item">
1819
+ <a href="../../explanation/references/" class="md-nav__link">
1820
+
1821
+
1822
+
1823
+ <span class="md-ellipsis">
1824
+
1825
+
1826
+ Method References
1827
+
1828
+
1829
+
1830
+ </span>
1831
+
1832
+
1833
+
1834
+ </a>
1835
+ </li>
1836
+
1837
+
1838
+
1839
+
1840
+
1841
+
1842
+
1843
+
1844
+
1845
+
1846
+ <li class="md-nav__item">
1847
+ <a href="../../explanation/third-party-notices/" class="md-nav__link">
1848
+
1849
+
1850
+
1851
+ <span class="md-ellipsis">
1852
+
1853
+
1854
+ Third-party Notices
1855
+
1856
+
1857
+
1858
+ </span>
1859
+
1860
+
1861
+
1862
+ </a>
1863
+ </li>
1864
+
1865
+
1866
+
1867
+
1868
+ </ul>
1869
+ </nav>
1870
+
1871
+ </li>
1872
+
1873
+
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+
1882
+
1883
+
1884
+
1885
+
1886
+
1887
+
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+
1906
+
1907
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1908
+
1909
+
1910
+
1911
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
1912
+
1913
+
1914
+ <div class="md-nav__link md-nav__container">
1915
+ <a href="../../development/" class="md-nav__link ">
1916
+
1917
+
1918
+
1919
+ <span class="md-ellipsis">
1920
+
1921
+
1922
+ Development
1923
+
1924
+
1925
+
1926
+ </span>
1927
+
1928
+
1929
+
1930
+ </a>
1931
+
1932
+
1933
+ <label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
1934
+ <span class="md-nav__icon md-icon"></span>
1935
+ </label>
1936
+
1937
+ </div>
1938
+
1939
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
1940
+ <label class="md-nav__title" for="__nav_10">
1941
+ <span class="md-nav__icon md-icon"></span>
1942
+
1943
+
1944
+ Development
1945
+
1946
+
1947
+ </label>
1948
+ <ul class="md-nav__list" data-md-scrollfix>
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+ <li class="md-nav__item">
1957
+ <a href="../../development/release-notes/" class="md-nav__link">
1958
+
1959
+
1960
+
1961
+ <span class="md-ellipsis">
1962
+
1963
+
1964
+ Release Notes
1965
+
1966
+
1967
+
1968
+ </span>
1969
+
1970
+
1971
+
1972
+ </a>
1973
+ </li>
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+ <li class="md-nav__item">
1985
+ <a href="../../development/tool-authoring/" class="md-nav__link">
1986
+
1987
+
1988
+
1989
+ <span class="md-ellipsis">
1990
+
1991
+
1992
+ Tool Authoring
1993
+
1994
+
1995
+
1996
+ </span>
1997
+
1998
+
1999
+
2000
+ </a>
2001
+ </li>
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+ <li class="md-nav__item">
2013
+ <a href="../../development/documentation/" class="md-nav__link">
2014
+
2015
+
2016
+
2017
+ <span class="md-ellipsis">
2018
+
2019
+
2020
+ Documentation
2021
+
2022
+
2023
+
2024
+ </span>
2025
+
2026
+
2027
+
2028
+ </a>
2029
+ </li>
2030
+
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+ <li class="md-nav__item">
2041
+ <a href="../../development/contributing/" class="md-nav__link">
2042
+
2043
+
2044
+
2045
+ <span class="md-ellipsis">
2046
+
2047
+
2048
+ Contributing
2049
+
2050
+
2051
+
2052
+ </span>
2053
+
2054
+
2055
+
2056
+ </a>
2057
+ </li>
2058
+
2059
+
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+ <li class="md-nav__item">
2069
+ <a href="../../development/security/" class="md-nav__link">
2070
+
2071
+
2072
+
2073
+ <span class="md-ellipsis">
2074
+
2075
+
2076
+ Security Reporting
2077
+
2078
+
2079
+
2080
+ </span>
2081
+
2082
+
2083
+
2084
+ </a>
2085
+ </li>
2086
+
2087
+
2088
+
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+ <li class="md-nav__item">
2097
+ <a href="../../development/release-readiness/" class="md-nav__link">
2098
+
2099
+
2100
+
2101
+ <span class="md-ellipsis">
2102
+
2103
+
2104
+ Release Readiness
2105
+
2106
+
2107
+
2108
+ </span>
2109
+
2110
+
2111
+
2112
+ </a>
2113
+ </li>
2114
+
2115
+
2116
+
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+ <li class="md-nav__item">
2125
+ <a href="../../development/ci-publishing/" class="md-nav__link">
2126
+
2127
+
2128
+
2129
+ <span class="md-ellipsis">
2130
+
2131
+
2132
+ CI and Publishing
2133
+
2134
+
2135
+
2136
+ </span>
2137
+
2138
+
2139
+
2140
+ </a>
2141
+ </li>
2142
+
2143
+
2144
+
2145
+
2146
+ </ul>
2147
+ </nav>
2148
+
2149
+ </li>
2150
+
2151
+
2152
+
2153
+ </ul>
2154
+ </nav>
2155
+ </div>
2156
+ </div>
2157
+ </div>
2158
+
2159
+
2160
+
2161
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2162
+ <div class="md-sidebar__scrollwrap">
2163
+ <div class="md-sidebar__inner">
2164
+
2165
+
2166
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2167
+
2168
+
2169
+
2170
+
2171
+
2172
+
2173
+ <label class="md-nav__title" for="__toc">
2174
+ <span class="md-nav__icon md-icon"></span>
2175
+ Table of contents
2176
+ </label>
2177
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2178
+
2179
+ <li class="md-nav__item">
2180
+ <a href="#dataset-and-moleculeset" class="md-nav__link">
2181
+ <span class="md-ellipsis">
2182
+
2183
+ Dataset and MoleculeSet
2184
+
2185
+ </span>
2186
+ </a>
2187
+
2188
+ </li>
2189
+
2190
+ <li class="md-nav__item">
2191
+ <a href="#workflow" class="md-nav__link">
2192
+ <span class="md-ellipsis">
2193
+
2194
+ Workflow
2195
+
2196
+ </span>
2197
+ </a>
2198
+
2199
+ </li>
2200
+
2201
+ <li class="md-nav__item">
2202
+ <a href="#job" class="md-nav__link">
2203
+ <span class="md-ellipsis">
2204
+
2205
+ Job
2206
+
2207
+ </span>
2208
+ </a>
2209
+
2210
+ </li>
2211
+
2212
+ <li class="md-nav__item">
2213
+ <a href="#backend" class="md-nav__link">
2214
+ <span class="md-ellipsis">
2215
+
2216
+ Backend
2217
+
2218
+ </span>
2219
+ </a>
2220
+
2221
+ </li>
2222
+
2223
+ <li class="md-nav__item">
2224
+ <a href="#result" class="md-nav__link">
2225
+ <span class="md-ellipsis">
2226
+
2227
+ Result
2228
+
2229
+ </span>
2230
+ </a>
2231
+
2232
+ </li>
2233
+
2234
+ </ul>
2235
+
2236
+ </nav>
2237
+ </div>
2238
+ </div>
2239
+ </div>
2240
+
2241
+
2242
+
2243
+ <div class="md-content" data-md-component="content">
2244
+
2245
+ <article class="md-content__inner md-typeset">
2246
+
2247
+
2248
+
2249
+
2250
+
2251
+
2252
+
2253
+
2254
+ <h1 id="concepts">Concepts<a class="headerlink" href="#concepts" title="Permanent link">&para;</a></h1>
2255
+ <h2 id="dataset-and-moleculeset">Dataset and MoleculeSet<a class="headerlink" href="#dataset-and-moleculeset" title="Permanent link">&para;</a></h2>
2256
+ <p><code>Dataset</code> represents a reproducible collection of data such as molecules and labels. <code>MoleculeSet</code>
2257
+ represents a collection of molecules used by workflows and models. Both are frozen
2258
+ dataclasses, but contained lists and molecular objects are not deeply immutable.
2259
+ <code>Dataset.from_molecules()</code> is implemented; <code>Dataset.from_file()</code> currently raises
2260
+ <code>NotImplementedError</code>. File input is handled by tool-specific configuration/workflows.</p>
2261
+ <p>See the <a href="../../reference/api/">public API reference</a> for constructors and fields.</p>
2262
+ <p>Future data sources may include databases, but tool APIs should continue to accept stable core data
2263
+ objects rather than tool-specific containers.</p>
2264
+ <h2 id="workflow">Workflow<a class="headerlink" href="#workflow" title="Permanent link">&para;</a></h2>
2265
+ <p>A <code>Workflow</code> orchestrates one scientific protocol, such as docking, MD, FEP, QM, or property
2266
+ prediction. Workflows are backend-agnostic and delegate execution to backends through the core job
2267
+ infrastructure.</p>
2268
+ <h2 id="job">Job<a class="headerlink" href="#job" title="Permanent link">&para;</a></h2>
2269
+ <p>A <code>Job</code> represents one execution of a workflow. Jobs carry a unique ID, status, timestamps, backend
2270
+ metadata, and paths to the standardized run directory and logs.</p>
2271
+ <h2 id="backend">Backend<a class="headerlink" href="#backend" title="Permanent link">&para;</a></h2>
2272
+ <p>A <code>Backend</code> submits, tracks, and cancels jobs. Core backends include local execution and Slurm.
2273
+ Workflows should not know Slurm-specific or local-process details.</p>
2274
+ <h2 id="result">Result<a class="headerlink" href="#result" title="Permanent link">&para;</a></h2>
2275
+ <p>A <code>Result</code> is the canonical outcome of a job. Results include the job ID, tool name, status,
2276
+ metrics, and paths to important output files. Tools may store richer tool-specific data under their
2277
+ result directory, but the canonical result should remain loadable through the core helpers.</p>
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+ </article>
2292
+ </div>
2293
+
2294
+
2295
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2296
+ </div>
2297
+
2298
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
2299
+
2300
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
2301
+ Back to top
2302
+ </button>
2303
+
2304
+ </main>
2305
+
2306
+ <footer class="md-footer">
2307
+
2308
+ <div class="md-footer-meta md-typeset">
2309
+ <div class="md-footer-meta__inner md-grid">
2310
+ <div class="md-copyright">
2311
+
2312
+
2313
+ Made with
2314
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2315
+ Material for MkDocs
2316
+ </a>
2317
+
2318
+ </div>
2319
+
2320
+ </div>
2321
+ </div>
2322
+ </footer>
2323
+
2324
+ </div>
2325
+ <div class="md-dialog" data-md-component="dialog">
2326
+ <div class="md-dialog__inner md-typeset"></div>
2327
+ </div>
2328
+
2329
+
2330
+
2331
+
2332
+
2333
+ <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.sections", "navigation.indexes", "navigation.top", "search.highlight", "search.suggest", "content.code.copy"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
2334
+
2335
+
2336
+ <script src="../../assets/javascripts/bundle.d7400e89.min.js"></script>
2337
+
2338
+
2339
+ </body>
2340
+ </html>