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

Cleanup example notebooks #496

Merged
merged 7 commits into from
Nov 22, 2024
Merged

Cleanup example notebooks #496

merged 7 commits into from
Nov 22, 2024

Conversation

teutoburg
Copy link
Contributor

@teutoburg teutoburg commented Nov 10, 2024

Just clone the IRDB into the docs build, seems to work fine (after two days of frustrating debugging). Using the scopesimple interface will ensure the relevant packages are downloaded in the absence of the clone (yes I tested that locally).

Sorry for the force push mess, at some point I forgot there's already a PR for this...

RTD page is far from being perfect, but probably as good as we will get it before the workshop...

@teutoburg teutoburg added the documentation Improvements or additions to documentation label Nov 10, 2024
Copy link

codecov bot commented Nov 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.04%. Comparing base (7a277c1) to head (4cb5e0a).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #496      +/-   ##
==========================================
- Coverage   77.16%   77.04%   -0.12%     
==========================================
  Files          66       66              
  Lines        8207     8204       -3     
==========================================
- Hits         6333     6321      -12     
- Misses       1874     1883       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@teutoburg teutoburg marked this pull request as ready for review November 10, 2024 14:57
@teutoburg teutoburg marked this pull request as draft November 10, 2024 20:05
@teutoburg teutoburg removed the request for review from hugobuddel November 10, 2024 20:05
@teutoburg teutoburg force-pushed the fh/fixdocsnotebooks branch 4 times, most recently from 01e60fe to 462b053 Compare November 20, 2024 13:15
@teutoburg teutoburg force-pushed the fh/fixdocsnotebooks branch 2 times, most recently from 06710f7 to 003e1fc Compare November 20, 2024 14:53
Remove package download

Use scopesimple interface for examples
This is the scopesimple couterpart to load_example_optical_train.
This was clashing with tqdm.auto, producing ugly double progress bars.
This should make the docs build fail if there are any errors in the notebooks, which used to just go silent in the past. This should allow us to catch them sooner...
@teutoburg teutoburg marked this pull request as ready for review November 22, 2024 12:38
@hugobuddel
Copy link
Collaborator

Looks good! I haven't experimented yet with the ScopeSimple mode.

I think these are a bit too short:

data_lfoa = lfoa(source, dit=10, ndit=360)[1].data

I would prefer to have the hdus inbetween, because that is more clear to the users I think. But this is fine too

@teutoburg
Copy link
Contributor Author

I think these are a bit too short:

data_lfoa = lfoa(source, dit=10, ndit=360)[1].data

I would prefer to have the hdus inbetween, because that is more clear to the users I think. But this is fine too

IIRC there's also an example in the docs that shows the HDUL as an in-between step, mentioning that it can be saved to disk.

@teutoburg teutoburg merged commit 32a00ed into main Nov 22, 2024
22 checks passed
@teutoburg teutoburg deleted the fh/fixdocsnotebooks branch November 22, 2024 13:11
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
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants