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

Provide clear instructions how to run/analyze an example simulation #4

Closed
mstimberg opened this issue Dec 9, 2022 · 1 comment
Closed

Comments

@mstimberg
Copy link

[Issue opened as part of review openjournals/joss-reviews#4944]

The repository contains an example config file in build/configs.csv which I think is a coarse-grained version of the simulation included in the paper. The documentation should use this (or another) example to give step-by-step instructions how to run a simulation and analyze the results. Currently, the wiki only states "Analyse the experiment by dropping the experiment folder on one of the python scripts in the experiments folder" – I would strongly recommend augmenting this by a description of what each script does. The Python scripts also depend on external libraries (matplotlib, pandas), these dependencies should be stated.

@Venku628
Copy link
Contributor

Venku628 commented Jan 7, 2023

0b3ba56

@Venku628 Venku628 closed this as completed Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants