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

Fix most notebook dependency issues #121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

LuukvanKeeken
Copy link

I updated the docs/requirements.txt file, I assume that should help with the dependency issues in the notebooks. Spinnaker2 I couldn't find in pip so that isn't solved here.

There seem to be some other errors in the notebooks as well. Some are just because of incorrect variables (e.g. 'input_type' instead of 'output_type' in the lava example). But also, the way in which the NIRGraph in e.g. the lava example is created doesn't work, seemingly because a dict of nodes is expected instead of a list. Should a different issue be made for these problems?

…issue of the docs notebooks (except for spinnaker2 which doesn't seem to be available in pip).
@Jegp
Copy link
Collaborator

Jegp commented Dec 16, 2024

Thank you for the changes! @LuukvanKeeken, could I ask you to remind me what this fixes again? I built the docs with your changes and it worked well - but it also worked well without the added dependencies. Of course, the notebooks won't be run, but they still function as static pages.

Is this for interactive notebooks?

@LuukvanKeeken
Copy link
Author

@Jegp it was regarding this issue: #106. I never saw the error messages themselves, I assumed they wouldn't be visible to me anyway. Based on the description in the issue I figured that any dependency problems of this kind would be solved by adding the packages to docs/requirements.txt

@Jegp
Copy link
Collaborator

Jegp commented Dec 17, 2024

Ah, right. Thank you! Yes. Ok. I'm afraid the issue is slightly deprecated, which is entirely my fault. The situation is this:
By default the doc builder (sphinx/jupyter book) executes the notebook, but we disabled that earlier so that Sphinx now converts the notebook content directly into a website without running the content. So, from that perspective, the dependency issue actually disappeared.

But! It's not over. It would be nice to have executable notebooks for two reasons

  1. It would permit users to run the code themselves directly from the docs, and
  2. It would be a constant "test" that the code still runs

In some sense this is the original meaning of the issue: we want the notebooks to run, so we can execute them in the docs. Would you be up for working towards that? It requires setting a few configuration options for Jupyter Book and ensuring that the page is generated properly. It's a pretty nice piece of tech that's extremely useful for generating pretty and useful sites.

Sorry for leaving this issue so ambiguous

@LuukvanKeeken
Copy link
Author

Ah I see! That sounds doable, I'll look into it in the near future

@Jegp
Copy link
Collaborator

Jegp commented Jan 3, 2025

Perfect. Thank you for the understanding @LuukvanKeeken. I'll see to cleaning up in the issues to keep them ajour.

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