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.

Sign up for GitHub

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

Jump to bottom

Adds Jupyter notebooks and MATLAB live scripts to the examples #30

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Adds Jupyter notebooks and MATLAB live scripts to the examples #30

wants to merge 15 commits into from

Conversation

alexhroom
Copy link
Collaborator

This PR fixes #18 by splitting the examples folder into a separate folder for each language. The MATLAB folder contains the tutorials, with HTML exports of the live scripts embedded. The Python folder contains Jupyter notebooks converted via nbsphinx.

@alexhroom alexhroom force-pushed the 18-jupyter-notebooks branch 6 times, most recently from 11ae0e8 to a23b773 Compare January 29, 2025 12:07
@alexhroom alexhroom marked this pull request as ready for review January 29, 2025 12:10
StephenNneji
StephenNneji reviewed Feb 6, 2025
View reviewed changes
Copy link
Collaborator

@StephenNneji StephenNneji left a comment

Choose a reason for hiding this comment

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

Thanks for this, see comments

  1. Please update README with instruction to build example and install Pandoc
  2. The instruction to run the Python examples have been removed and I think that information is arguably more important than adding the notebooks so we have to add them back. We could consider moving the Examples up one level out of the user guide so the navigation will look like
    Home Installation User Guide Examples References
    This should give more flexibility so we can have instructions to run the examples and notebooks separately.
  3. I don't know what's going on here with the duplicate numbers
    Screenshot 2025-02-06 130246

setup_tutorials.sh Outdated Show resolved Hide resolved
@alexhroom
Copy link
Collaborator Author

alexhroom commented Feb 6, 2025 •
edited
Loading

@StephenNneji regarding

The instruction to run the Python examples have been removed and I think that information is arguably more important than adding the notebooks so we have to add them back...

there is a setting for nbconvert where you can add a prolog to notebooks, with information on how to run them (see e.g. the nbconvert docs, entirely written in Jupyter, where they use the prolog to provide download and binder links). Would adding the information on how to run the scripts to the prolog do?

@alexhroom alexhroom force-pushed the 18-jupyter-notebooks branch 2 times, most recently from 7a219d5 to 21e8e97 Compare February 7, 2025 09:55
@StephenNneji
Copy link
Collaborator

there is a setting for nbconvert where you can add a prolog to notebooks, with information on how to run them (see e.g. the nbconvert docs, entirely written in Jupyter, where they use the prolog to provide download and binder links). Would adding the information on how to run the scripts to the prolog do?

I don't know how it will look but we also need instructions for people running the examples as a script or function not just the notebook. People might ignore the prolog and assume its for the notebook users

@alexhroom
Copy link
Collaborator Author

@StephenNneji the prolog doesn't have to resemble the one in the example I gave: it just lets you put a block of text before the notebook. This would have the same structure as the MATLAB examples

@alexhroom alexhroom force-pushed the 18-jupyter-notebooks branch from 21e8e97 to fbdc15f Compare February 13, 2025 08:11
@alexhroom alexhroom force-pushed the 18-jupyter-notebooks branch from fbdc15f to e8e6e25 Compare February 13, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StephenNneji StephenNneji Awaiting requested review from StephenNneji

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Integrate jupyter notebook examples into docs
2 participants
@alexhroom @StephenNneji