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

Examples in documentation not run #431

Open
2 tasks
fneum opened this issue Feb 26, 2025 · 6 comments · May be fixed by #433
Open
2 tasks

Examples in documentation not run #431

fneum opened this issue Feb 26, 2025 · 6 comments · May be fixed by #433

Comments

@fneum
Copy link
Member

fneum commented Feb 26, 2025

Version Checks (indicate both or one)

  • I have confirmed this bug exists on the lastest release of atlite.

  • I have confirmed this bug exists on the current master branch of atlite.

Issue Description

See https://atlite.readthedocs.io/en/latest/examples/landuse-availability.html

Reproducible Example

N/A

Expected Behavior

The outputs of the code cells should be shown. They should be run on Readthedocs when building the documentation.

Installed Versions

N/A

@lkstrp
Copy link
Member

lkstrp commented Mar 5, 2025

This is not a bug, but they were never actually run. Not sure if this is intentional, as some atlite examples just take too long? @euronion?

@euronion
Copy link
Collaborator

euronion commented Mar 5, 2025

I believe we set it up like this because running them would take a long time / consume too many resources.

However the outputs have in the past been included in the examples and upload.
Someone just deleted all the outputs at some point (1e42c17)

@lkstrp lkstrp linked a pull request Mar 5, 2025 that will close this issue
@lkstrp
Copy link
Member

lkstrp commented Mar 5, 2025

Makes sense. Thank you!

@fneum
Copy link
Member Author

fneum commented Mar 6, 2025

Ah, great. So just a different setup than in PyPSA (where .ipynb are run in the build stage of the docs).

@euronion
Copy link
Collaborator

euronion commented Mar 6, 2025

Could be a low prio improvement to have the examples run during the build stage of the docs?

@lkstrp
Copy link
Member

lkstrp commented Mar 6, 2025

Yeah, as done in PyPSA/PyPSA for example. But I barley looked at it and I think with resources needed right now this is a very low prio improvement. The bigger cutouts would need to be cached

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants