-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve doc (no graphviz) (and fix readthedocs build?)
- Loading branch information
Showing
5 changed files
with
39 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,4 +44,4 @@ cleanall: clean | |
@rm -rf _generated/* | ||
|
||
format: | ||
mdformat --wrap 88 *.md | ||
mdformat --wrap 88 . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ maxdepth: 1 | |
--- | ||
restart.md | ||
history_points.md | ||
snek-make.md | ||
``` | ||
|
||
## For developer of Snek5000 solvers | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
jupytext: | ||
formats: ipynb,md:myst | ||
text_representation: | ||
extension: .md | ||
format_name: myst | ||
format_version: 0.13 | ||
jupytext_version: 1.14.1 | ||
kernelspec: | ||
display_name: Python 3 (ipykernel) | ||
language: python | ||
name: python3 | ||
--- | ||
|
||
# How to execute Snakemake commands from a directory | ||
|
||
Sometimes, it can be useful to execute the Snakemake targets without Python coding from | ||
the directory of a simulation. Calling directly Snakemake can be slightly difficult so | ||
there is a Snek5000 command, `snek-make`, for this task. The help of this function can | ||
be obtained with (the `!` is for calling a command in Jupyter): | ||
|
||
```{code-cell} ipython3 | ||
!snek-make -h | ||
``` | ||
|
||
From a simulation directory, `snek-make -l` lists the available targets. One can do for | ||
example: | ||
|
||
```bash | ||
snek-make cleanall | ||
snek-make compile | ||
snek-make show_config | ||
snek-make run_fg | ||
``` |