Skip to content

Commit 783630f

Browse files
committed
rename backend to implementation
1 parent d5257fd commit 783630f

File tree

13 files changed

+31
-31
lines changed

13 files changed

+31
-31
lines changed

docs/advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Here is an example that shows how to swap out constant pressure implementations.
66

77
```yaml
88
wic:
9-
default_backend: gromacs
10-
backends:
9+
default_implementation: gromacs
10+
implementations:
1111
gromacs:
1212
steps:
1313
- npt_gromacs.wic:
@@ -31,7 +31,7 @@ wic:
3131
steps:
3232
(2, npt.wic):
3333
wic:
34-
backend: amber
34+
implementation: amber
3535
```
3636
This will override the default implementation of `gromacs` and use `amber`. This really just means that `npt_amber.wic` is called instead of `npt_gromacs.wic` (If `--insert_steps_automatically` is enabled, the compiler will attempt to automatically insert the necessary file format conversions as determined below.)
3737

docs/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
Subworkflows are used extensively to create reusable building blocks.
66

7-
For example, a basic molecular dynamics workflow is composed of minimization, equilibration, and production steps, the equilibration step is composed of constant volume (NVT) and constant pressure (NPT) steps, and each of those are composed of primitive backend-specific steps. If we then want to do a stability analysis, we should be able to incorporate the molecular dynamics workflow as a black box, and we should only have to append the stability analysis subworkflow. See [here](https://github.com/PolusAI/mm-workflows/blob/main/examples/gromacs/tutorial.wic)!
7+
For example, a basic molecular dynamics workflow is composed of minimization, equilibration, and production steps, the equilibration step is composed of constant volume (NVT) and constant pressure (NPT) steps, and each of those are composed of primitive implementation-specific steps. If we then want to do a stability analysis, we should be able to incorporate the molecular dynamics workflow as a black box, and we should only have to append the stability analysis subworkflow. See [here](https://github.com/PolusAI/mm-workflows/blob/main/examples/gromacs/tutorial.wic)!
88

9-
* Multiple backends
9+
* Multiple implementations
1010

11-
There are often several backend engines that implement the same algorithm (e.g. amber / gromacs / namd). In principle, each backend ought to be exactly interchangeable, but in practice backends may randomly crash, etc. For this reason, we want the ability to arbitrarily switch backends at any step. Moreover, different users may be familiar with different backends, but we still want to compose together their workflows.
11+
There are often several implementation engines that implement the same algorithm (e.g. amber / gromacs / namd). In principle, each implementation ought to be exactly interchangeable, but in practice implementations may randomly crash, etc. For this reason, we want the ability to arbitrarily switch implementations at any step. Moreover, different users may be familiar with different implementations, but we still want to compose together their workflows.
1212

13-
For example, we should be able to compose system setup using amber/tleap, equilibration using namd, and metadynamics using gromacs. File format conversions should be automatically inserted between steps. This is not possible with other 'backend-independent' software packages which require a single backend to be fixed at the beginning and used throughout.
13+
For example, we should be able to compose system setup using amber/tleap, equilibration using namd, and metadynamics using gromacs. File format conversions should be automatically inserted between steps. This is not possible with other 'implementation-independent' software packages which require a single implementation to be fixed at the beginning and used throughout.
1414

1515
See [static dispatch](advanced.md#static-dispatch)
1616

examples/docking/docking_stability.wic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ wic:
3939
steps:
4040
(4, cwl_watcher_analysis.wic):
4141
wic:
42-
backend: complex
42+
implementation: complex
4343
(3, analysis.wic):
4444
wic:
4545
steps:
4646
(1, analysis_realtime.wic):
4747
wic:
48-
backend: complex
48+
implementation: complex

examples/docking/vs_demo_2.wic

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,16 +180,16 @@ wic:
180180
- output_edr_path: !& prod.edr
181181
(4, cwl_watcher_analysis.wic):
182182
wic:
183-
backend: complex
183+
implementation: complex
184184
(3, analysis.wic):
185185
wic:
186186
steps:
187187
(1, analysis_realtime.wic):
188188
wic:
189-
backend: complex
189+
implementation: complex
190190
(2, analysis_final.wic):
191191
wic:
192-
backend: complex
192+
implementation: complex
193193
(11, autodock_vina_rescore.wic):
194194
wic:
195195
inlineable: False

examples/docking/vs_demo_3.wic

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,16 @@ wic:
156156
- output_edr_path: !& prod.edr
157157
(4, cwl_watcher_analysis.wic):
158158
wic:
159-
backend: complex
159+
implementation: complex
160160
(3, analysis.wic):
161161
wic:
162162
steps:
163163
(1, analysis_realtime.wic):
164164
wic:
165-
backend: complex
165+
implementation: complex
166166
(2, analysis_final.wic):
167167
wic:
168-
backend: complex
168+
implementation: complex
169169
(9, autodock_vina_rescore.wic):
170170
wic:
171171
inlineable: False

examples/docking/vs_demo_4.wic

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,16 +231,16 @@ wic:
231231
- output_edr_path: !& prod.edr
232232
(4, cwl_watcher_analysis.wic):
233233
wic:
234-
backend: complex
234+
implementation: complex
235235
(3, analysis.wic):
236236
wic:
237237
steps:
238238
(1, analysis_realtime.wic):
239239
wic:
240-
backend: complex
240+
implementation: complex
241241
(2, analysis_final.wic):
242242
wic:
243-
backend: complex
243+
implementation: complex
244244
(13, autodock_vina_rescore.wic):
245245
wic:
246246
inlineable: False

examples/gromacs/analysis_final.wic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
wic:
2-
default_backend: protein
3-
backends:
2+
default_implementation: protein
3+
implementations:
44
protein:
55
steps:
66
- analysis_final_steps.wic:

examples/gromacs/analysis_realtime.wic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
wic:
2-
default_backend: protein
3-
backends:
2+
default_implementation: protein
3+
implementations:
44
protein:
55
steps:
66
- analysis_realtime_protein.wic:

examples/gromacs/cwl_watcher_analysis.wic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
wic:
2-
default_backend: protein
3-
backends:
2+
default_implementation: protein
3+
implementations:
44
protein:
55
steps:
66
- cwl_watcher_protein.wic:

examples/gromacs/equil.wic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ wic:
88
steps:
99
(2, npt.wic):
1010
wic:
11-
backend: gromacs
12-
# backend: amber
11+
implementation: gromacs
12+
# implementation: amber

0 commit comments

Comments
 (0)