Skip to content

Example not documented - adding documentation #15

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.

Sign up for GitHub

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

Open
luiznery wants to merge 1 commit into
base: support_official
Choose a base branch
from
Open

Example not documented - adding documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Executing the example locally

After cloning the repo, with `git switch support_official` and switching to the proper branch `git switch support_official`, it is important to setup correctly the environment. To do so we recommend to use NIX + direnv.

To run the example locally follow those steps:

1. Enter the proper directory:
`cd example`
2. Compile the code:
```
cmake -S . -B build
make -C build
```
3. Copy the simulation to the directory `experiment`:
`cp build/simulation experiment/`
4. Enter in directory `experiment`:
`cd experiment`
5. Execute the script `script.sh`, this will launch a Dask scheduler, launch the Dask workers, execute the python code in `../derivative.py`, and finally run the simulation:
`bash script.sh`

Note: after running it, if you finish the script with Ctrl+C it is important to kill Dask processes: `pkill dask`.