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

docs: automatically sync quickstart tutorial with codebase #136

Merged
merged 5 commits into from
Dec 18, 2023

Conversation

nicrie
Copy link
Collaborator

@nicrie nicrie commented Dec 17, 2023

At present, there is a risk of the documentation and the codebase becoming out of sync. To mitigate this risk, ensure that the output of the Jupyter notebooks is cleared before committing. Subsequently, allow ReadTheDocs to rerun the notebook. For now, apply this process solely to the Quick Start tutorial. (address part of #130)

@codecov-commenter
Copy link

Codecov Report

Attention: 66 lines in your changes are missing coverage. Please review.

Comparison is base (0f95d04) 94.21% compared to head (ec42f2f) 94.31%.
Report is 50 commits behind head on main.

Files Patch % Lines
xeofs/utils/numba_utils.py 20.96% 49 Missing ⚠️
xeofs/data_container/data_container.py 88.88% 3 Missing ⚠️
xeofs/preprocessing/stacker.py 72.72% 3 Missing ⚠️
xeofs/models/_base_cross_model.py 96.07% 2 Missing ⚠️
xeofs/models/_base_model.py 96.07% 2 Missing ⚠️
xeofs/models/decomposer.py 86.66% 2 Missing ⚠️
xeofs/preprocessing/preprocessor.py 88.88% 2 Missing ⚠️
xeofs/utils/xarray_utils.py 88.88% 2 Missing ⚠️
xeofs/utils/io.py 97.95% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #136      +/-   ##
==========================================
+ Coverage   94.21%   94.31%   +0.09%     
==========================================
  Files          71       73       +2     
  Lines        5823     6083     +260     
==========================================
+ Hits         5486     5737     +251     
- Misses        337      346       +9     

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

@malmans2
Copy link
Member

@nicrie try to save the notebook with the default kernel (Python 3) instead of the one you've been using locally.
I.e., this metadata should look like this:

 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  }

@nicrie nicrie marked this pull request as ready for review December 18, 2023 22:00
@nicrie nicrie merged commit 48e63a0 into main Dec 18, 2023
6 of 7 checks passed
@nicrie
Copy link
Collaborator Author

nicrie commented Dec 18, 2023

Thanks @malmans2 that did the trick!

@nicrie nicrie deleted the sync-code-notebooks branch December 19, 2023 10:59
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.

None yet

3 participants