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

Update Examples #268

Merged
merged 13 commits into from
Dec 12, 2024
Merged

Update Examples #268

merged 13 commits into from
Dec 12, 2024

Conversation

nreinicke
Copy link
Collaborator

@nreinicke nreinicke commented Dec 12, 2024

Builds off of #238 to update our examples. Now, we have three main examples:

  • Open Street Maps Example: The goto beginning example that shows how to build a dataset and run the application
  • Different Powertrain Example: Dives a bit deeper into the differences between running different powertrains
  • Time Energy Tradeoff Example: Dives deeper into comparing time and energy tradeoffs

I also moved the examples to standard python scripts which should make them much easier to manage with version control / linting / formatting.

When building the docs, we can now call python docs/examples/_convert_examples_to_notbooks.py which converts all the examples to notebooks prior to building the docs since jupyter book expects them.

Closes #238

Copy link
Collaborator

@robfitzgerald robfitzgerald left a comment

Choose a reason for hiding this comment

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

nice setup, should be easy to add examples and avoid stale notebook state. i think the only drawback with that is that the notebook output cells are not rendered, so, that makes reading the examples on the web somewhat ineffective. i'm happy to approve though and maybe we try and figure out how to render those cells on release.

thanks!

@nreinicke
Copy link
Collaborator Author

i think the only drawback with that is that the notebook output cells are not rendered, so, that makes reading the examples on the web somewhat ineffective.

Yeah that's true that they won't be rendered from within GitHub but if everything works as expected, the outputs will be rendered in the html documentation once it gets built. Would that address your concern?

@robfitzgerald
Copy link
Collaborator

Oh it does? Ya that's actually purrrfect

@nreinicke nreinicke merged commit 9dc9a65 into main Dec 12, 2024
5 checks passed
@nreinicke nreinicke deleted the ndr/update-examples branch December 12, 2024 20:54
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.

3 participants