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

Notebook Guide to Data Extraction #210

Merged

Conversation

joyvelasquez
Copy link
Contributor

This pull request introduces a new Jupyter Notebook titled "A Practical Guide to Data Extraction and Visualization" into the docs/notebooks/getting_started directory. This notebook is designed to provide users with a step-by-step tutorial on how to download and analyze solar observation data using the Hinode X-Ray Telescope (XRT) through the xrtpy package.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@joyvelasquez joyvelasquez self-assigned this Feb 23, 2024
@joyvelasquez joyvelasquez added the notebook Working on jupyter notebooks label Feb 23, 2024
@joyvelasquez joyvelasquez added this to the 0.5.0 milestone Feb 23, 2024
@joyvelasquez
Copy link
Contributor Author

Hi @namurphy & @jslavin ,

I have completed the notebook I was working on and believe it's ready to be included in the "Example, Getting Started" section of xrtpy.

Could I kindly ask for your review of this notebook? Thank you very much in advance for your time and assistance!

@joyvelasquez
Copy link
Contributor Author

pre-commit.ci autofix

@namurphy
Copy link
Contributor

It looks like the documentation build error is occurring because it's trying to import packages that are not among the project requirements. The missing requirements will need to be added to both requirements/docs.txt and to docs under [options.extras_require] in setup.cfg.

@joyvelasquez
Copy link
Contributor Author

pre-commit.ci autofix

@joyvelasquez
Copy link
Contributor Author

Hi @namurphy ,

I've reached a point with a problem that I can't seem to resolve on my own. Although I've made progress and overcome other issues, the Documentation error still persists, and I'm unable to fix it. Could you possibly offer any advice or guidance on this matter? Thank you!

@joyvelasquez
Copy link
Contributor Author

Hi @namurphy,
I can't find and fix the last ruff rule failing error. I've checked cell_5:63:15, but nothing is clear for a fix. Can you help me out and check it?

Thanks!

docs/notebooks/getting_started/A_Practical_Guide_to_Data_Extraction_and_Visualization.ipynb:cell_5:63:15: TRY003 Avoid specifying long messages outside the exception class
Found 1 error.

@joyvelasquez joyvelasquez merged commit e073ab4 into HinodeXRT:main Jun 3, 2024
9 checks passed
@joyvelasquez joyvelasquez deleted the xrt_data_practice_user_guide branch June 3, 2024 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notebook Working on jupyter notebooks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants