Skip to content

Commit

Permalink
Add more chapters
Browse files Browse the repository at this point in the history
  • Loading branch information
nx10 committed Sep 13, 2024
1 parent 22ce354 commit 79e17e3
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@
- [The Styx Book](./README.md)
- [Getting started](./getting_started/README.md)
- [Runners](./getting_started/runners.md)
- [I/O: Where are my files?](./getting_started/io.md)
- [Tips & best practices](./getting_started/tips_best_practices.md)
- [Contributing to NiWrap](./getting_started/contributing_to_niwrap.md)
- [Advanced concepts](./advanced_concepts/README.md)
- [Writing custom runners](./advanced_concepts/custom_runners.md)
- [Contributing to the Styx compiler](./advanced_concepts/styx_compiler.md)
- [Examples](./examples/README.md)

- [Example: MRI anatomical preproc](./examples/anat_preproc.md)
- [Example: Generate mermaid graph](./examples/mermaid.md)
- [Example: Dynamic runners](./examples/dynamic_runners.md)
1 change: 1 addition & 0 deletions src/advanced_concepts/styx_compiler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contributing to the Styx compiler
1 change: 1 addition & 0 deletions src/examples/anat_preproc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example: MRI anatomical preproc
1 change: 1 addition & 0 deletions src/examples/dynamic_runners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example: Dynamic runners
1 change: 1 addition & 0 deletions src/examples/mermaid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example: Generate mermaid graph
1 change: 1 addition & 0 deletions src/getting_started/io.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# I/O: Runner file handling
1 change: 1 addition & 0 deletions src/getting_started/runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ While this might be good for debugging, other users might want to control where
There are a of number official runners:

- `styxdefs.LocalRunner` - This is the default Runner. It executes commands locally.
- `styxdefs.DummyRunner` - ?
- [`styxdocker.DockerRunner`](https://github.com/childmindresearch/styxdocker) - This Runner executes every command in a Docker container.
- [`styxsingularity.SingularityRunner`](https://github.com/childmindresearch/styxsingularity) - This Runner executes every command in an Apptainer/Singularity container.
- [`styxgraph.GraphRunner`](https://github.com/childmindresearch/styxgraph) - This is a special Runner - it captures information about how your commands are connected and returns a diagram.
Expand Down

0 comments on commit 79e17e3

Please sign in to comment.