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

Test tutorials #399

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

Conversation

ElliottKasoar
Copy link
Member

@ElliottKasoar ElliottKasoar commented Feb 3, 2025

Resolves #386

Adds basic tutorials from https://github.com/stfc/janus-tutorials, with minor formatting changes.

These are built as part of the publishing workflow, so must run successfully before janus-core is published to PyPI.

An example: https://elliottkasoar.github.io/janus-core/tutorials/single_point.html

To do:

  • Add note in dev docs for building/running, including need to install pandoc on system

@ElliottKasoar ElliottKasoar added documentation Improvements or additions to documentation enhancement New/improved feature or request labels Feb 3, 2025
@ElliottKasoar ElliottKasoar self-assigned this Feb 3, 2025
cd docs
make clean; make tutorials


Copy link
Member

Choose a reason for hiding this comment

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

I will add a paragraph with the google colab shortcuts... they are in the readme of the old repo, may need to be updated to match

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New/improved feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Test tutorials
2 participants