-
Notifications
You must be signed in to change notification settings - Fork 10
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
Clean up example notebooks #210
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a script left in the notebooks folder that hasn't been addressed: https://github.com/arup-group/genet/tree/clean-example-notebooks/notebooks
I think that this folder should disappear altogether since it will be confusing to have both examples and notebooks folders. The script that's left generates the wiki pages based on notebook content. I would like to keep it, people have given a lot of positive feedback for the wiki; it also makes it easy to link people to specific sections.
On the side, what's the reason behind mix of cases in the naming of notebooks? they are partially lower case
RE wiki generator script, good catch. I'll move that over to the "examples" dir for this PR. once we have GitHub pages I would remove it and the wiki in favour of the notebooks being rendered there (as is done in PAM e.g.: https://arup-group.github.io/pam/v0.3.1/examples/01_basics/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the jupyter notebooks are duplicated, something must have gone wrong with renaming them?
Damn... Git is generally case insensitive so I had to override a config option to make it see the case changes. I don't see duplicates locally so clearly this config change made it very confused. |
7c1ee56
to
adc6190
Compare
Force pushed a change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good to go!
Relatively minor change to align genet with the CML Python template.
examples
and outputs from notebooks are confined toexamples/example_data/outputs