# Workflow Directory Layout

A workflow directory contains `motoko.yaml`, an orchestrator Python file, and
one subdirectory per study:

```text
workflow/
  motoko.yaml
  orchestrator.py
  study1/
    bd.yaml
    launch.sh
    doIt.py
  study2/
    bd.yaml
    launch.sh
    doIt.py
```

Each study directory contains:

- `bd.yaml`: the BlackDynamite description of the parametric space.
- `doIt.py`: the code that runs the calculation.
- `launch.sh`: the launcher used by the job submission manager, such as bash,
  Slurm, or PBS.

Once the workflow has been started, Motoko saves workflow state in
`workflow/.wf/`. BlackDynamite saves each study's state in
`workflow/study*/.bd/`. Directories containing produced run output are stored
in `BD-study*-runs/`.

## Runtime files

Motoko and BlackDynamite create runtime state while the workflow runs. These
directories should usually be treated as generated state rather than source
files:

- `.wf/`: Motoko workflow database and runtime state.
- `.bd/`: BlackDynamite state inside each study directory.
- `BD-*-runs/`: run directories created by BlackDynamite.