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,2359 @@
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/">
14
+
15
+
16
+
17
+ <link rel="next" href="getting-started/">
18
+
19
+
20
+
21
+
22
+
23
+ <link rel="icon" href="assets/images/favicon.png">
24
+ <meta name="generator" content="mkdocs-ProperDocs 1.6.7, mkdocs-material-9.7.7">
25
+
26
+
27
+
28
+ <title>CADDForge</title>
29
+
30
+
31
+
32
+ <link rel="stylesheet" href="assets/stylesheets/main.ec1eaa64.min.css">
33
+
34
+
35
+ <link rel="stylesheet" href="assets/stylesheets/palette.ab4e12ef.min.css">
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+ <link rel="stylesheet" href="assets/_mkdocstrings.css">
49
+
50
+ <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>
51
+
52
+
53
+
54
+
55
+
56
+ </head>
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="teal">
67
+
68
+
69
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
70
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
71
+ <label class="md-overlay" for="__drawer"></label>
72
+ <div data-md-component="skip">
73
+
74
+
75
+ <a href="#caddforge" class="md-skip">
76
+ Skip to content
77
+ </a>
78
+
79
+ </div>
80
+ <div data-md-component="announce">
81
+
82
+ </div>
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <header class="md-header md-header--shadow" data-md-component="header">
90
+ <nav class="md-header__inner md-grid" aria-label="Header">
91
+ <a href="." title="CADDForge" class="md-header__button md-logo" aria-label="CADDForge" data-md-component="logo">
92
+
93
+
94
+ <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>
95
+
96
+ </a>
97
+ <label class="md-header__button md-icon" for="__drawer">
98
+
99
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
100
+ </label>
101
+ <div class="md-header__title" data-md-component="header-title">
102
+ <div class="md-header__ellipsis">
103
+ <div class="md-header__topic">
104
+ <span class="md-ellipsis">
105
+ CADDForge
106
+ </span>
107
+ </div>
108
+ <div class="md-header__topic" data-md-component="header-topic">
109
+ <span class="md-ellipsis">
110
+
111
+ Home
112
+
113
+ </span>
114
+ </div>
115
+ </div>
116
+ </div>
117
+
118
+
119
+ <form class="md-header__option" data-md-component="palette">
120
+
121
+
122
+
123
+
124
+ <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">
125
+
126
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
127
+ <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>
128
+ </label>
129
+
130
+
131
+
132
+
133
+
134
+ <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">
135
+
136
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
137
+ <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>
138
+ </label>
139
+
140
+
141
+ </form>
142
+
143
+
144
+
145
+ <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>
146
+
147
+
148
+
149
+
150
+
151
+ <label class="md-header__button md-icon" for="__search">
152
+
153
+ <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>
154
+ </label>
155
+ <div class="md-search" data-md-component="search" role="dialog">
156
+ <label class="md-search__overlay" for="__search"></label>
157
+ <div class="md-search__inner" role="search">
158
+ <form class="md-search__form" name="search">
159
+ <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>
160
+ <label class="md-search__icon md-icon" for="__search">
161
+
162
+ <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>
163
+
164
+ <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>
165
+ </label>
166
+ <nav class="md-search__options" aria-label="Search">
167
+
168
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
169
+
170
+ <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>
171
+ </button>
172
+ </nav>
173
+
174
+ <div class="md-search__suggest" data-md-component="search-suggest"></div>
175
+
176
+ </form>
177
+ <div class="md-search__output">
178
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
179
+ <div class="md-search-result" data-md-component="search-result">
180
+ <div class="md-search-result__meta">
181
+ Initializing search
182
+ </div>
183
+ <ol class="md-search-result__list" role="presentation"></ol>
184
+ </div>
185
+ </div>
186
+ </div>
187
+ </div>
188
+ </div>
189
+
190
+
191
+
192
+ <div class="md-header__source">
193
+ <a href="https://github.com/idorsia/caddforge-docs" title="Go to repository" class="md-source" data-md-component="source">
194
+ <div class="md-source__icon md-icon">
195
+
196
+ <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>
197
+ </div>
198
+ <div class="md-source__repository">
199
+ caddforge-docs
200
+ </div>
201
+ </a>
202
+ </div>
203
+
204
+ </nav>
205
+
206
+ </header>
207
+
208
+ <div class="md-container" data-md-component="container">
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <main class="md-main" data-md-component="main">
216
+ <div class="md-main__inner md-grid">
217
+
218
+
219
+
220
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
221
+ <div class="md-sidebar__scrollwrap">
222
+ <div class="md-sidebar__inner">
223
+
224
+
225
+
226
+
227
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
228
+ <label class="md-nav__title" for="__drawer">
229
+ <a href="." title="CADDForge" class="md-nav__button md-logo" aria-label="CADDForge" data-md-component="logo">
230
+
231
+
232
+ <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>
233
+
234
+ </a>
235
+ CADDForge
236
+ </label>
237
+
238
+ <div class="md-nav__source">
239
+ <a href="https://github.com/idorsia/caddforge-docs" title="Go to repository" class="md-source" data-md-component="source">
240
+ <div class="md-source__icon md-icon">
241
+
242
+ <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>
243
+ </div>
244
+ <div class="md-source__repository">
245
+ caddforge-docs
246
+ </div>
247
+ </a>
248
+ </div>
249
+
250
+ <ul class="md-nav__list" data-md-scrollfix>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ <li class="md-nav__item md-nav__item--active">
261
+
262
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
263
+
264
+
265
+
266
+
267
+
268
+ <label class="md-nav__link md-nav__link--active" for="__toc">
269
+
270
+
271
+
272
+ <span class="md-ellipsis">
273
+
274
+
275
+ Home
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+ <span class="md-nav__icon md-icon"></span>
284
+ </label>
285
+
286
+ <a href="." class="md-nav__link md-nav__link--active">
287
+
288
+
289
+
290
+ <span class="md-ellipsis">
291
+
292
+
293
+ Home
294
+
295
+
296
+
297
+ </span>
298
+
299
+
300
+
301
+ </a>
302
+
303
+
304
+
305
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <label class="md-nav__title" for="__toc">
313
+ <span class="md-nav__icon md-icon"></span>
314
+ Table of contents
315
+ </label>
316
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
317
+
318
+ <li class="md-nav__item">
319
+ <a href="#design-goals" class="md-nav__link">
320
+ <span class="md-ellipsis">
321
+
322
+ Design goals
323
+
324
+ </span>
325
+ </a>
326
+
327
+ </li>
328
+
329
+ <li class="md-nav__item">
330
+ <a href="#choose-a-starting-point" class="md-nav__link">
331
+ <span class="md-ellipsis">
332
+
333
+ Choose a starting point
334
+
335
+ </span>
336
+ </a>
337
+
338
+ </li>
339
+
340
+ <li class="md-nav__item">
341
+ <a href="#quick-links" class="md-nav__link">
342
+ <span class="md-ellipsis">
343
+
344
+ Quick links
345
+
346
+ </span>
347
+ </a>
348
+
349
+ </li>
350
+
351
+ </ul>
352
+
353
+ </nav>
354
+
355
+ </li>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
384
+
385
+
386
+
387
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
388
+
389
+
390
+ <div class="md-nav__link md-nav__container">
391
+ <a href="getting-started/" class="md-nav__link ">
392
+
393
+
394
+
395
+ <span class="md-ellipsis">
396
+
397
+
398
+ Getting Started
399
+
400
+
401
+
402
+ </span>
403
+
404
+
405
+
406
+ </a>
407
+
408
+
409
+ <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
410
+ <span class="md-nav__icon md-icon"></span>
411
+ </label>
412
+
413
+ </div>
414
+
415
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
416
+ <label class="md-nav__title" for="__nav_2">
417
+ <span class="md-nav__icon md-icon"></span>
418
+
419
+
420
+ Getting Started
421
+
422
+
423
+ </label>
424
+ <ul class="md-nav__list" data-md-scrollfix>
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+ <li class="md-nav__item">
433
+ <a href="getting-started/installation/" class="md-nav__link">
434
+
435
+
436
+
437
+ <span class="md-ellipsis">
438
+
439
+
440
+ Installation
441
+
442
+
443
+
444
+ </span>
445
+
446
+
447
+
448
+ </a>
449
+ </li>
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+ <li class="md-nav__item">
461
+ <a href="getting-started/first-workflow/" class="md-nav__link">
462
+
463
+
464
+
465
+ <span class="md-ellipsis">
466
+
467
+
468
+ First Workflow
469
+
470
+
471
+
472
+ </span>
473
+
474
+
475
+
476
+ </a>
477
+ </li>
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+ <li class="md-nav__item">
489
+ <a href="getting-started/first-pipeline/" class="md-nav__link">
490
+
491
+
492
+
493
+ <span class="md-ellipsis">
494
+
495
+
496
+ First Pipeline
497
+
498
+
499
+
500
+ </span>
501
+
502
+
503
+
504
+ </a>
505
+ </li>
506
+
507
+
508
+
509
+
510
+ </ul>
511
+ </nav>
512
+
513
+ </li>
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
542
+
543
+
544
+
545
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
546
+
547
+
548
+ <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
549
+
550
+
551
+
552
+ <span class="md-ellipsis">
553
+
554
+
555
+ How-to Guides
556
+
557
+
558
+
559
+ </span>
560
+
561
+
562
+
563
+ <span class="md-nav__icon md-icon"></span>
564
+ </label>
565
+
566
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
567
+ <label class="md-nav__title" for="__nav_3">
568
+ <span class="md-nav__icon md-icon"></span>
569
+
570
+
571
+ How-to Guides
572
+
573
+
574
+ </label>
575
+ <ul class="md-nav__list" data-md-scrollfix>
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+ <li class="md-nav__item">
584
+ <a href="how-to/jobs/" class="md-nav__link">
585
+
586
+
587
+
588
+ <span class="md-ellipsis">
589
+
590
+
591
+ Jobs and Results
592
+
593
+
594
+
595
+ </span>
596
+
597
+
598
+
599
+ </a>
600
+ </li>
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+ <li class="md-nav__item">
612
+ <a href="how-to/scatter/" class="md-nav__link">
613
+
614
+
615
+
616
+ <span class="md-ellipsis">
617
+
618
+
619
+ Scatter and Reduce
620
+
621
+
622
+
623
+ </span>
624
+
625
+
626
+
627
+ </a>
628
+ </li>
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+ <li class="md-nav__item">
640
+ <a href="how-to/troubleshooting/" class="md-nav__link">
641
+
642
+
643
+
644
+ <span class="md-ellipsis">
645
+
646
+
647
+ Troubleshooting
648
+
649
+
650
+
651
+ </span>
652
+
653
+
654
+
655
+ </a>
656
+ </li>
657
+
658
+
659
+
660
+
661
+ </ul>
662
+ </nav>
663
+
664
+ </li>
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
699
+
700
+
701
+
702
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
703
+
704
+
705
+ <div class="md-nav__link md-nav__container">
706
+ <a href="core/" class="md-nav__link ">
707
+
708
+
709
+
710
+ <span class="md-ellipsis">
711
+
712
+
713
+ Core
714
+
715
+
716
+
717
+ </span>
718
+
719
+
720
+
721
+ </a>
722
+
723
+
724
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
725
+ <span class="md-nav__icon md-icon"></span>
726
+ </label>
727
+
728
+ </div>
729
+
730
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
731
+ <label class="md-nav__title" for="__nav_4">
732
+ <span class="md-nav__icon md-icon"></span>
733
+
734
+
735
+ Core
736
+
737
+
738
+ </label>
739
+ <ul class="md-nav__list" data-md-scrollfix>
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ <li class="md-nav__item">
748
+ <a href="core/concepts/" class="md-nav__link">
749
+
750
+
751
+
752
+ <span class="md-ellipsis">
753
+
754
+
755
+ Concepts
756
+
757
+
758
+
759
+ </span>
760
+
761
+
762
+
763
+ </a>
764
+ </li>
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+ <li class="md-nav__item">
776
+ <a href="core/configuration/" class="md-nav__link">
777
+
778
+
779
+
780
+ <span class="md-ellipsis">
781
+
782
+
783
+ Configuration
784
+
785
+
786
+
787
+ </span>
788
+
789
+
790
+
791
+ </a>
792
+ </li>
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+ <li class="md-nav__item">
804
+ <a href="core/cli/" class="md-nav__link">
805
+
806
+
807
+
808
+ <span class="md-ellipsis">
809
+
810
+
811
+ CLI
812
+
813
+
814
+
815
+ </span>
816
+
817
+
818
+
819
+ </a>
820
+ </li>
821
+
822
+
823
+
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+ <li class="md-nav__item">
832
+ <a href="core/jobs-results/" class="md-nav__link">
833
+
834
+
835
+
836
+ <span class="md-ellipsis">
837
+
838
+
839
+ Jobs and Results
840
+
841
+
842
+
843
+ </span>
844
+
845
+
846
+
847
+ </a>
848
+ </li>
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+
857
+
858
+
859
+ <li class="md-nav__item">
860
+ <a href="core/slurm/" class="md-nav__link">
861
+
862
+
863
+
864
+ <span class="md-ellipsis">
865
+
866
+
867
+ Slurm Backend
868
+
869
+
870
+
871
+ </span>
872
+
873
+
874
+
875
+ </a>
876
+ </li>
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+ <li class="md-nav__item">
888
+ <a href="core/plugins/" class="md-nav__link">
889
+
890
+
891
+
892
+ <span class="md-ellipsis">
893
+
894
+
895
+ Plugins
896
+
897
+
898
+
899
+ </span>
900
+
901
+
902
+
903
+ </a>
904
+ </li>
905
+
906
+
907
+
908
+
909
+ </ul>
910
+ </nav>
911
+
912
+ </li>
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+
940
+
941
+
942
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
943
+
944
+
945
+
946
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
947
+
948
+
949
+ <div class="md-nav__link md-nav__container">
950
+ <a href="pipelines/" class="md-nav__link ">
951
+
952
+
953
+
954
+ <span class="md-ellipsis">
955
+
956
+
957
+ Pipelines
958
+
959
+
960
+
961
+ </span>
962
+
963
+
964
+
965
+ </a>
966
+
967
+
968
+ <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
969
+ <span class="md-nav__icon md-icon"></span>
970
+ </label>
971
+
972
+ </div>
973
+
974
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
975
+ <label class="md-nav__title" for="__nav_5">
976
+ <span class="md-nav__icon md-icon"></span>
977
+
978
+
979
+ Pipelines
980
+
981
+
982
+ </label>
983
+ <ul class="md-nav__list" data-md-scrollfix>
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+ <li class="md-nav__item">
992
+ <a href="pipelines/specification/" class="md-nav__link">
993
+
994
+
995
+
996
+ <span class="md-ellipsis">
997
+
998
+
999
+ Specification
1000
+
1001
+
1002
+
1003
+ </span>
1004
+
1005
+
1006
+
1007
+ </a>
1008
+ </li>
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+ <li class="md-nav__item">
1020
+ <a href="pipelines/artifacts/" class="md-nav__link">
1021
+
1022
+
1023
+
1024
+ <span class="md-ellipsis">
1025
+
1026
+
1027
+ Artifacts
1028
+
1029
+
1030
+
1031
+ </span>
1032
+
1033
+
1034
+
1035
+ </a>
1036
+ </li>
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+ <li class="md-nav__item">
1048
+ <a href="pipelines/built-ins/" class="md-nav__link">
1049
+
1050
+
1051
+
1052
+ <span class="md-ellipsis">
1053
+
1054
+
1055
+ Built-in Stages
1056
+
1057
+
1058
+
1059
+ </span>
1060
+
1061
+
1062
+
1063
+ </a>
1064
+ </li>
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+ <li class="md-nav__item">
1076
+ <a href="pipelines/examples/" class="md-nav__link">
1077
+
1078
+
1079
+
1080
+ <span class="md-ellipsis">
1081
+
1082
+
1083
+ Examples
1084
+
1085
+
1086
+
1087
+ </span>
1088
+
1089
+
1090
+
1091
+ </a>
1092
+ </li>
1093
+
1094
+
1095
+
1096
+
1097
+ </ul>
1098
+ </nav>
1099
+
1100
+ </li>
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1139
+
1140
+
1141
+
1142
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1143
+
1144
+
1145
+ <div class="md-nav__link md-nav__container">
1146
+ <a href="plugins/" class="md-nav__link ">
1147
+
1148
+
1149
+
1150
+ <span class="md-ellipsis">
1151
+
1152
+
1153
+ Plugins
1154
+
1155
+
1156
+
1157
+ </span>
1158
+
1159
+
1160
+
1161
+ </a>
1162
+
1163
+
1164
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
1165
+ <span class="md-nav__icon md-icon"></span>
1166
+ </label>
1167
+
1168
+ </div>
1169
+
1170
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1171
+ <label class="md-nav__title" for="__nav_6">
1172
+ <span class="md-nav__icon md-icon"></span>
1173
+
1174
+
1175
+ Plugins
1176
+
1177
+
1178
+ </label>
1179
+ <ul class="md-nav__list" data-md-scrollfix>
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+ <li class="md-nav__item">
1188
+ <a href="plugins/version-matrix/" class="md-nav__link">
1189
+
1190
+
1191
+
1192
+ <span class="md-ellipsis">
1193
+
1194
+
1195
+ Version Matrix
1196
+
1197
+
1198
+
1199
+ </span>
1200
+
1201
+
1202
+
1203
+ </a>
1204
+ </li>
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+ <li class="md-nav__item">
1216
+ <a href="plugins/docking/" class="md-nav__link">
1217
+
1218
+
1219
+
1220
+ <span class="md-ellipsis">
1221
+
1222
+
1223
+ Docking
1224
+
1225
+
1226
+
1227
+ </span>
1228
+
1229
+
1230
+
1231
+ </a>
1232
+ </li>
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+ <li class="md-nav__item">
1244
+ <a href="plugins/descriptors/" class="md-nav__link">
1245
+
1246
+
1247
+
1248
+ <span class="md-ellipsis">
1249
+
1250
+
1251
+ Descriptors
1252
+
1253
+
1254
+
1255
+ </span>
1256
+
1257
+
1258
+
1259
+ </a>
1260
+ </li>
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+ <li class="md-nav__item">
1272
+ <a href="plugins/md/" class="md-nav__link">
1273
+
1274
+
1275
+
1276
+ <span class="md-ellipsis">
1277
+
1278
+
1279
+ MD
1280
+
1281
+
1282
+
1283
+ </span>
1284
+
1285
+
1286
+
1287
+ </a>
1288
+ </li>
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+
1296
+
1297
+
1298
+
1299
+ <li class="md-nav__item">
1300
+ <a href="plugins/fep/" class="md-nav__link">
1301
+
1302
+
1303
+
1304
+ <span class="md-ellipsis">
1305
+
1306
+
1307
+ FEP
1308
+
1309
+
1310
+
1311
+ </span>
1312
+
1313
+
1314
+
1315
+ </a>
1316
+ </li>
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+ <li class="md-nav__item">
1328
+ <a href="plugins/qm/" class="md-nav__link">
1329
+
1330
+
1331
+
1332
+ <span class="md-ellipsis">
1333
+
1334
+
1335
+ QM
1336
+
1337
+
1338
+
1339
+ </span>
1340
+
1341
+
1342
+
1343
+ </a>
1344
+ </li>
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+ <li class="md-nav__item">
1356
+ <a href="plugins/ml/" class="md-nav__link">
1357
+
1358
+
1359
+
1360
+ <span class="md-ellipsis">
1361
+
1362
+
1363
+ ML
1364
+
1365
+
1366
+
1367
+ </span>
1368
+
1369
+
1370
+
1371
+ </a>
1372
+ </li>
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+ <li class="md-nav__item">
1384
+ <a href="plugins/datascience/" class="md-nav__link">
1385
+
1386
+
1387
+
1388
+ <span class="md-ellipsis">
1389
+
1390
+
1391
+ Data Science
1392
+
1393
+
1394
+
1395
+ </span>
1396
+
1397
+
1398
+
1399
+ </a>
1400
+ </li>
1401
+
1402
+
1403
+
1404
+
1405
+ </ul>
1406
+ </nav>
1407
+
1408
+ </li>
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1435
+
1436
+
1437
+
1438
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
1439
+
1440
+
1441
+ <div class="md-nav__link md-nav__container">
1442
+ <a href="gui/" class="md-nav__link ">
1443
+
1444
+
1445
+
1446
+ <span class="md-ellipsis">
1447
+
1448
+
1449
+ GUI
1450
+
1451
+
1452
+
1453
+ </span>
1454
+
1455
+
1456
+
1457
+ </a>
1458
+
1459
+
1460
+ <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
1461
+ <span class="md-nav__icon md-icon"></span>
1462
+ </label>
1463
+
1464
+ </div>
1465
+
1466
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1467
+ <label class="md-nav__title" for="__nav_7">
1468
+ <span class="md-nav__icon md-icon"></span>
1469
+
1470
+
1471
+ GUI
1472
+
1473
+
1474
+ </label>
1475
+ <ul class="md-nav__list" data-md-scrollfix>
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+ <li class="md-nav__item">
1484
+ <a href="gui/walkthrough/" class="md-nav__link">
1485
+
1486
+
1487
+
1488
+ <span class="md-ellipsis">
1489
+
1490
+
1491
+ Walkthrough
1492
+
1493
+
1494
+
1495
+ </span>
1496
+
1497
+
1498
+
1499
+ </a>
1500
+ </li>
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+ <li class="md-nav__item">
1512
+ <a href="gui/plugin-authoring/" class="md-nav__link">
1513
+
1514
+
1515
+
1516
+ <span class="md-ellipsis">
1517
+
1518
+
1519
+ Plugin GUI Authoring
1520
+
1521
+
1522
+
1523
+ </span>
1524
+
1525
+
1526
+
1527
+ </a>
1528
+ </li>
1529
+
1530
+
1531
+
1532
+
1533
+ </ul>
1534
+ </nav>
1535
+
1536
+ </li>
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1565
+
1566
+
1567
+
1568
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
1569
+
1570
+
1571
+ <div class="md-nav__link md-nav__container">
1572
+ <a href="reference/" class="md-nav__link ">
1573
+
1574
+
1575
+
1576
+ <span class="md-ellipsis">
1577
+
1578
+
1579
+ Reference
1580
+
1581
+
1582
+
1583
+ </span>
1584
+
1585
+
1586
+
1587
+ </a>
1588
+
1589
+
1590
+ <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
1591
+ <span class="md-nav__icon md-icon"></span>
1592
+ </label>
1593
+
1594
+ </div>
1595
+
1596
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
1597
+ <label class="md-nav__title" for="__nav_8">
1598
+ <span class="md-nav__icon md-icon"></span>
1599
+
1600
+
1601
+ Reference
1602
+
1603
+
1604
+ </label>
1605
+ <ul class="md-nav__list" data-md-scrollfix>
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+ <li class="md-nav__item">
1614
+ <a href="reference/api/" class="md-nav__link">
1615
+
1616
+
1617
+
1618
+ <span class="md-ellipsis">
1619
+
1620
+
1621
+ Public Python API
1622
+
1623
+
1624
+
1625
+ </span>
1626
+
1627
+
1628
+
1629
+ </a>
1630
+ </li>
1631
+
1632
+
1633
+
1634
+
1635
+
1636
+
1637
+
1638
+
1639
+
1640
+
1641
+ <li class="md-nav__item">
1642
+ <a href="examples/" class="md-nav__link">
1643
+
1644
+
1645
+
1646
+ <span class="md-ellipsis">
1647
+
1648
+
1649
+ Example Library
1650
+
1651
+
1652
+
1653
+ </span>
1654
+
1655
+
1656
+
1657
+ </a>
1658
+ </li>
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+ <li class="md-nav__item">
1670
+ <a href="examples/quickstart/" class="md-nav__link">
1671
+
1672
+
1673
+
1674
+ <span class="md-ellipsis">
1675
+
1676
+
1677
+ Example Data Provenance
1678
+
1679
+
1680
+
1681
+ </span>
1682
+
1683
+
1684
+
1685
+ </a>
1686
+ </li>
1687
+
1688
+
1689
+
1690
+
1691
+ </ul>
1692
+ </nav>
1693
+
1694
+ </li>
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1723
+
1724
+
1725
+
1726
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
1727
+
1728
+
1729
+ <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
1730
+
1731
+
1732
+
1733
+ <span class="md-ellipsis">
1734
+
1735
+
1736
+ Explanation
1737
+
1738
+
1739
+
1740
+ </span>
1741
+
1742
+
1743
+
1744
+ <span class="md-nav__icon md-icon"></span>
1745
+ </label>
1746
+
1747
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
1748
+ <label class="md-nav__title" for="__nav_9">
1749
+ <span class="md-nav__icon md-icon"></span>
1750
+
1751
+
1752
+ Explanation
1753
+
1754
+
1755
+ </label>
1756
+ <ul class="md-nav__list" data-md-scrollfix>
1757
+
1758
+
1759
+
1760
+
1761
+
1762
+
1763
+
1764
+ <li class="md-nav__item">
1765
+ <a href="explanation/reproducibility/" class="md-nav__link">
1766
+
1767
+
1768
+
1769
+ <span class="md-ellipsis">
1770
+
1771
+
1772
+ Reproducibility
1773
+
1774
+
1775
+
1776
+ </span>
1777
+
1778
+
1779
+
1780
+ </a>
1781
+ </li>
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+
1792
+ <li class="md-nav__item">
1793
+ <a href="explanation/references/" class="md-nav__link">
1794
+
1795
+
1796
+
1797
+ <span class="md-ellipsis">
1798
+
1799
+
1800
+ Method References
1801
+
1802
+
1803
+
1804
+ </span>
1805
+
1806
+
1807
+
1808
+ </a>
1809
+ </li>
1810
+
1811
+
1812
+
1813
+
1814
+
1815
+
1816
+
1817
+
1818
+
1819
+
1820
+ <li class="md-nav__item">
1821
+ <a href="explanation/third-party-notices/" class="md-nav__link">
1822
+
1823
+
1824
+
1825
+ <span class="md-ellipsis">
1826
+
1827
+
1828
+ Third-party Notices
1829
+
1830
+
1831
+
1832
+ </span>
1833
+
1834
+
1835
+
1836
+ </a>
1837
+ </li>
1838
+
1839
+
1840
+
1841
+
1842
+ </ul>
1843
+ </nav>
1844
+
1845
+ </li>
1846
+
1847
+
1848
+
1849
+
1850
+
1851
+
1852
+
1853
+
1854
+
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+
1870
+
1871
+
1872
+
1873
+
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+ <li class="md-nav__item md-nav__item--section md-nav__item--nested">
1882
+
1883
+
1884
+
1885
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
1886
+
1887
+
1888
+ <div class="md-nav__link md-nav__container">
1889
+ <a href="development/" class="md-nav__link ">
1890
+
1891
+
1892
+
1893
+ <span class="md-ellipsis">
1894
+
1895
+
1896
+ Development
1897
+
1898
+
1899
+
1900
+ </span>
1901
+
1902
+
1903
+
1904
+ </a>
1905
+
1906
+
1907
+ <label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
1908
+ <span class="md-nav__icon md-icon"></span>
1909
+ </label>
1910
+
1911
+ </div>
1912
+
1913
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
1914
+ <label class="md-nav__title" for="__nav_10">
1915
+ <span class="md-nav__icon md-icon"></span>
1916
+
1917
+
1918
+ Development
1919
+
1920
+
1921
+ </label>
1922
+ <ul class="md-nav__list" data-md-scrollfix>
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+
1930
+ <li class="md-nav__item">
1931
+ <a href="development/release-notes/" class="md-nav__link">
1932
+
1933
+
1934
+
1935
+ <span class="md-ellipsis">
1936
+
1937
+
1938
+ Release Notes
1939
+
1940
+
1941
+
1942
+ </span>
1943
+
1944
+
1945
+
1946
+ </a>
1947
+ </li>
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+ <li class="md-nav__item">
1959
+ <a href="development/tool-authoring/" class="md-nav__link">
1960
+
1961
+
1962
+
1963
+ <span class="md-ellipsis">
1964
+
1965
+
1966
+ Tool Authoring
1967
+
1968
+
1969
+
1970
+ </span>
1971
+
1972
+
1973
+
1974
+ </a>
1975
+ </li>
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+ <li class="md-nav__item">
1987
+ <a href="development/documentation/" class="md-nav__link">
1988
+
1989
+
1990
+
1991
+ <span class="md-ellipsis">
1992
+
1993
+
1994
+ Documentation
1995
+
1996
+
1997
+
1998
+ </span>
1999
+
2000
+
2001
+
2002
+ </a>
2003
+ </li>
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+
2014
+ <li class="md-nav__item">
2015
+ <a href="development/contributing/" class="md-nav__link">
2016
+
2017
+
2018
+
2019
+ <span class="md-ellipsis">
2020
+
2021
+
2022
+ Contributing
2023
+
2024
+
2025
+
2026
+ </span>
2027
+
2028
+
2029
+
2030
+ </a>
2031
+ </li>
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+
2041
+
2042
+ <li class="md-nav__item">
2043
+ <a href="development/security/" class="md-nav__link">
2044
+
2045
+
2046
+
2047
+ <span class="md-ellipsis">
2048
+
2049
+
2050
+ Security Reporting
2051
+
2052
+
2053
+
2054
+ </span>
2055
+
2056
+
2057
+
2058
+ </a>
2059
+ </li>
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+
2069
+
2070
+ <li class="md-nav__item">
2071
+ <a href="development/release-readiness/" class="md-nav__link">
2072
+
2073
+
2074
+
2075
+ <span class="md-ellipsis">
2076
+
2077
+
2078
+ Release Readiness
2079
+
2080
+
2081
+
2082
+ </span>
2083
+
2084
+
2085
+
2086
+ </a>
2087
+ </li>
2088
+
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+
2097
+
2098
+ <li class="md-nav__item">
2099
+ <a href="development/ci-publishing/" class="md-nav__link">
2100
+
2101
+
2102
+
2103
+ <span class="md-ellipsis">
2104
+
2105
+
2106
+ CI and Publishing
2107
+
2108
+
2109
+
2110
+ </span>
2111
+
2112
+
2113
+
2114
+ </a>
2115
+ </li>
2116
+
2117
+
2118
+
2119
+
2120
+ </ul>
2121
+ </nav>
2122
+
2123
+ </li>
2124
+
2125
+
2126
+
2127
+ </ul>
2128
+ </nav>
2129
+ </div>
2130
+ </div>
2131
+ </div>
2132
+
2133
+
2134
+
2135
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2136
+ <div class="md-sidebar__scrollwrap">
2137
+ <div class="md-sidebar__inner">
2138
+
2139
+
2140
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+ <label class="md-nav__title" for="__toc">
2148
+ <span class="md-nav__icon md-icon"></span>
2149
+ Table of contents
2150
+ </label>
2151
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2152
+
2153
+ <li class="md-nav__item">
2154
+ <a href="#design-goals" class="md-nav__link">
2155
+ <span class="md-ellipsis">
2156
+
2157
+ Design goals
2158
+
2159
+ </span>
2160
+ </a>
2161
+
2162
+ </li>
2163
+
2164
+ <li class="md-nav__item">
2165
+ <a href="#choose-a-starting-point" class="md-nav__link">
2166
+ <span class="md-ellipsis">
2167
+
2168
+ Choose a starting point
2169
+
2170
+ </span>
2171
+ </a>
2172
+
2173
+ </li>
2174
+
2175
+ <li class="md-nav__item">
2176
+ <a href="#quick-links" class="md-nav__link">
2177
+ <span class="md-ellipsis">
2178
+
2179
+ Quick links
2180
+
2181
+ </span>
2182
+ </a>
2183
+
2184
+ </li>
2185
+
2186
+ </ul>
2187
+
2188
+ </nav>
2189
+ </div>
2190
+ </div>
2191
+ </div>
2192
+
2193
+
2194
+
2195
+ <div class="md-content" data-md-component="content">
2196
+
2197
+ <article class="md-content__inner md-typeset">
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+ <h1 id="caddforge">CADDForge<a class="headerlink" href="#caddforge" title="Permanent link">&para;</a></h1>
2207
+ <p>CADDForge is the central CADD toolbox framework for running computational chemistry and modelling
2208
+ workflows through a consistent Python API, CLI, plugin system, job model, and pipeline layer.</p>
2209
+ <p>The project is split into a lightweight core package and tool-specific plugin packages:</p>
2210
+ <table>
2211
+ <thead>
2212
+ <tr>
2213
+ <th>Package</th>
2214
+ <th>Purpose</th>
2215
+ </tr>
2216
+ </thead>
2217
+ <tbody>
2218
+ <tr>
2219
+ <td><code>caddforge</code></td>
2220
+ <td>Metadata-only installer for the complete public toolbox.</td>
2221
+ </tr>
2222
+ <tr>
2223
+ <td><code>caddforge-core</code></td>
2224
+ <td>Core abstractions, CLI, job execution, backends, pipeline engine, plugin registry.</td>
2225
+ </tr>
2226
+ <tr>
2227
+ <td><code>caddforge-docking</code></td>
2228
+ <td>Docking and rescoring workflows.</td>
2229
+ </tr>
2230
+ <tr>
2231
+ <td><code>caddforge-descriptors</code></td>
2232
+ <td>Molecular descriptor and property workflows.</td>
2233
+ </tr>
2234
+ <tr>
2235
+ <td><code>caddforge-md</code></td>
2236
+ <td>Molecular dynamics setup and execution workflows.</td>
2237
+ </tr>
2238
+ <tr>
2239
+ <td><code>caddforge-fep</code></td>
2240
+ <td>Absolute and relative free-energy workflows.</td>
2241
+ </tr>
2242
+ <tr>
2243
+ <td><code>caddforge-qm</code></td>
2244
+ <td>COSMO-RS transfer-free-energy workflow.</td>
2245
+ </tr>
2246
+ <tr>
2247
+ <td><code>caddforge-ml</code></td>
2248
+ <td>Machine-learning workflows and model utilities.</td>
2249
+ </tr>
2250
+ <tr>
2251
+ <td><code>caddforge-datascience</code></td>
2252
+ <td>Generic data-science utilities exposed as CADDForge tools.</td>
2253
+ </tr>
2254
+ <tr>
2255
+ <td><code>caddforge-gui</code></td>
2256
+ <td>Web GUI and plugin GUI extension runtime.</td>
2257
+ </tr>
2258
+ <tr>
2259
+ <td><code>caddforge-docs</code></td>
2260
+ <td>Installed documentation and optional browser command.</td>
2261
+ </tr>
2262
+ </tbody>
2263
+ </table>
2264
+ <h2 id="design-goals">Design goals<a class="headerlink" href="#design-goals" title="Permanent link">&para;</a></h2>
2265
+ <ul>
2266
+ <li>Standardize CADD workflow execution without putting tool-specific science into core.</li>
2267
+ <li>Keep workflows backend-agnostic through local and HPC backends.</li>
2268
+ <li>Store configs, logs, metadata, and results in predictable run directories.</li>
2269
+ <li>Let plugins declare their inputs, outputs, and pipeline contracts.</li>
2270
+ <li>Support large-scale file and path-collection scatter through the central pipeline executor.</li>
2271
+ </ul>
2272
+ <h2 id="choose-a-starting-point">Choose a starting point<a class="headerlink" href="#choose-a-starting-point" title="Permanent link">&para;</a></h2>
2273
+ <ul>
2274
+ <li>New users: <a href="getting-started/installation/">install selected components</a>, then
2275
+ run the <a href="getting-started/first-workflow/">local workflow tutorial</a>.</li>
2276
+ <li>Pipeline users: follow the <a href="getting-started/first-pipeline/">small pipeline tutorial</a>
2277
+ before adapting scientific templates.</li>
2278
+ <li>Python users: consult the <a href="reference/api/">public API</a> and <a href="examples/">example library</a>.</li>
2279
+ <li>Contributors: read <a href="development/contributing/">development guidance</a>.</li>
2280
+ </ul>
2281
+ <p>The planned <code>caddforge</code> distribution installs the complete public bundle, including
2282
+ <code>caddforge-docs</code> and its offline viewer. Its updated public release is still pending;
2283
+ install published components individually in the meantime. <code>caddforge-core</code> owns
2284
+ Python imports and the CLI, and docs remain optional for selective installations.
2285
+ These pages describe the tagged public component set; check the
2286
+ <a href="plugins/version-matrix/">version matrix</a> and <a href="development/release-readiness/">release prerequisites</a>
2287
+ for availability.</p>
2288
+ <h2 id="quick-links">Quick links<a class="headerlink" href="#quick-links" title="Permanent link">&para;</a></h2>
2289
+ <ul>
2290
+ <li><a href="getting-started/installation/">Installation</a></li>
2291
+ <li><a href="getting-started/first-workflow/">First workflow</a></li>
2292
+ <li><a href="core/cli/">CLI reference</a></li>
2293
+ <li><a href="pipelines/">Pipeline documentation</a></li>
2294
+ <li><a href="plugins/">Plugin catalog</a></li>
2295
+ <li><a href="development/tool-authoring/">Tool authoring</a></li>
2296
+ </ul>
2297
+
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+
2304
+
2305
+
2306
+
2307
+
2308
+
2309
+
2310
+ </article>
2311
+ </div>
2312
+
2313
+
2314
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2315
+ </div>
2316
+
2317
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
2318
+
2319
+ <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>
2320
+ Back to top
2321
+ </button>
2322
+
2323
+ </main>
2324
+
2325
+ <footer class="md-footer">
2326
+
2327
+ <div class="md-footer-meta md-typeset">
2328
+ <div class="md-footer-meta__inner md-grid">
2329
+ <div class="md-copyright">
2330
+
2331
+
2332
+ Made with
2333
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2334
+ Material for MkDocs
2335
+ </a>
2336
+
2337
+ </div>
2338
+
2339
+ </div>
2340
+ </div>
2341
+ </footer>
2342
+
2343
+ </div>
2344
+ <div class="md-dialog" data-md-component="dialog">
2345
+ <div class="md-dialog__inner md-typeset"></div>
2346
+ </div>
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+ <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>
2353
+
2354
+
2355
+ <script src="assets/javascripts/bundle.d7400e89.min.js"></script>
2356
+
2357
+
2358
+ </body>
2359
+ </html>