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

Clean up example notebooks #210

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Clean up example notebooks #210

merged 3 commits into from
Dec 19, 2023

Conversation

brynpickering
Copy link
Contributor

Relatively minor change to align genet with the CML Python template.

  • Notebooks are renamed to be machine-friendly
  • Example data is moved to a sub-dir within examples and outputs from notebooks are confined to examples/example_data/outputs
  • Some data is moved to the test dir where it is only referenced in the test dir
  • Removed unused files (one data file that is an example notebook output and the notebook smoke tests)

@brynpickering
Copy link
Contributor Author

This is blocking #214 btw @KasiaKoz

Copy link
Collaborator

@KasiaKoz KasiaKoz left a 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

examples/1_intro_to_genet.ipynb Show resolved Hide resolved
examples/3_2_writing_data_GTFS.ipynb Outdated Show resolved Hide resolved
@brynpickering
Copy link
Contributor Author

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/).

Copy link
Collaborator

@KasiaKoz KasiaKoz left a 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?

@brynpickering
Copy link
Contributor Author

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.

@brynpickering
Copy link
Contributor Author

Force pushed a change. git mv upper_case_file lower_case_file is our friend.

@KasiaKoz KasiaKoz self-requested a review December 19, 2023 10:28
Copy link
Collaborator

@KasiaKoz KasiaKoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good to go!

@brynpickering brynpickering merged commit c57bcbc into main Dec 19, 2023
2 checks passed
@brynpickering brynpickering deleted the clean-example-notebooks branch December 19, 2023 12:09
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

Successfully merging this pull request may close these issues.

2 participants