Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Sweep GHA Fix] The GitHub Actions run failed with... #141

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/installguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ You should now have the `wic` executable available in your terminal.

## Jupyter notebook visualization

The visualization currently needs to be in its own conda environment.
The visualization currently needs to be in its own conda environment. To set up the `vis` conda environment, execute the following commands:

```
./install_conda.sh
Expand Down
13 changes: 13 additions & 0 deletions docs/tutorials/multistep.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,24 @@ steps:
config:
pdb_code: 1aki
output_pdb_path: '&protein.pdb'
input_pdb_path: '*protein.pdb'
- fix_amides:
in:
input_pdb_path: '*protein.pdb'
output_pdb_path: '&protein_fix_amides.pdb'
input_pdb_path: '*protein.pdb'
- fix_side_chain:
in:
input_pdb_path: '*protein_fix_amides.pdb'
output_pdb_path: '&protein_fix_side_chain.pdb'
input_pdb_path: '*protein_fix_amides.pdb'
- extract_model:
in:
config:
models: [1]
input_structure_path: '*protein_fix_side_chain.pdb'
output_structure_path: '&protein_model_1.pdb'
input_structure_path: '*protein_fix_side_chain.pdb'
```

</td>
Expand All @@ -44,6 +48,15 @@ docs/tutorials/multistep1.yml.gv.png

## Explicit Edges

When defining explicit edges between output and input files, the following rules should be followed:
1. Use the `&` prefix for the output file and the `*` prefix for the input file in each step.
2. The `&` prefix must come first and can only be defined once for any file.
3. After defining the `&` prefix, you can use the `*` prefix multiple times in any subsequent steps.

For example, when connecting the output of step A to the input of step B, use the following format:
- Step A output: &fileA.ext
- Step B input: *fileA.ext

The first thing you might notice is that all of the filenames are prefixed with `&` and then `*` (and they are in quotes). This is the syntax for explicitly creating an edge between an output and a later input. Note that `&` must come first and can only be defined once, but then you can use `*` multiple times in any later step.

Note that if you just use regular filenames, they are treated as inputs which are external to the workflow, and thus are assumed to already exist on your filesystem. For example, if we remove the `&` and `*` around `protein_fix_amides.pdb`, we will get the following error message:
Expand Down
Loading