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

Example Usage: Narrative examples to guide new users #9

Closed
hayesall opened this issue Jul 13, 2021 · 1 comment
Closed

Example Usage: Narrative examples to guide new users #9

hayesall opened this issue Jul 13, 2021 · 1 comment

Comments

@hayesall
Copy link
Contributor

The nnde_demos repository has good notes, but their presentation makes them difficult to follow.

Recommendation: Include Sphinx documentation or Jupyter notebooks to show steps of the computation alongside the narration for what occurs.


sphinx documentation with the sphinx-gallery plugin is one option, or Jupyter notebooks can usually be rendered on GitHub.

For a real-world example of the sphinx-gallery approach, here is a web page that is generated from a markdown document

@elwinter
Copy link
Owner

elwinter commented Aug 1, 2021

I added a Jupyter notebook (tutorial.ipynb) to the nnde_demos repository (https://github.com/elwinter/nnde_demos) that walks the user through the process of solving a 1st-order ODE IVP using the nnde ppackage and examining the resulting network and the solutions it generates.

@elwinter elwinter closed this as completed Aug 1, 2021
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