Skip to content

Space weather docs - #7

Merged
aburrell merged 8 commits into
developfrom
space_weather_docs
Oct 2, 2026
Merged

aburrell merged 8 commits into
developfrom
space_weather_docs

Conversation

@aburrell

@aburrell aburrell commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator

Description

Added documentation about the space weather instruments to the docs

Type of change

  • This change requires a documentation update

How Has This Been Tested?

Built the docs locally

Test Configuration:

  • Operating system: OS X Tahoe
  • Version number: Python 3.10
  • Any details about your local setup that are relevant

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have linted the files updated in this pull request
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes
  • Update CITATION.cff file for new code contributors

If this is a release PR, replace the first item of the above checklist with the
release checklist on this wiki:
https://github.com/aburrell/ocbpy/wiki/Release-Checklist

Add specific examples using space weather instruments.
Add the examples to the index.
Add the space weather instruments to the instruments section.
Added badges for the main CI tests and coveralls.
Remove debug statements from the doc yaml.
Fixed a wrong directory name and a bad label.
Added a summary of changes to the changelog.

@aburrell aburrell left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found typos

Comment thread docs/examples/ex_ace.rst Outdated
Comment thread docs/examples/ex_mock_downloads.rst Outdated
Comment thread docs/examples/ex_mock_downloads.rst Outdated
Comment thread docs/examples/ex_mock_downloads.rst Outdated
Comment thread docs/instruments/sw_instruments.rst Outdated
Fixed typos in the docs.

Co-authored-by: Angeline Burrell <aburrell@users.noreply.github.com>
@coveralls

coveralls commented Oct 2, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 37060335991

Coverage decreased (-0.3%) to 94.208%

Details

  • Coverage decreased (-0.3%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 38 coverage regressions across 15 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

38 previously-covered lines in 15 files lost coverage.

Top 10 Files by Coverage Loss Lines Losing Coverage Coverage
_instrument.py 7 93.56%
utils/_core.py 4 97.38%
instruments/init.py 3 76.92%
instruments/sw_methods/init.py 2 85.71%
instruments/sw_methods/swpc.py 2 87.83%
_params.py 2 96.3%
tests/test_sw_methods_ace.py 2 96.55%
tests/test_sw_methods_ae.py 2 91.67%
tests/test_sw_methods_f107.py 2 98.31%
tests/test_sw_methods_general.py 2 91.67%

Coverage Stats

Coverage Status
Relevant Lines: 11188
Covered Lines: 10540
Line Coverage: 94.21%
Coverage Strength: 0.94 hits per line

💛 - Coveralls

@aburrell
aburrell merged commit 7243a32 into develop Oct 2, 2026
112 of 114 checks passed
@aburrell
aburrell deleted the space_weather_docs branch October 2, 2026 22:42
@aburrell aburrell added this to the v0.1.0 milestone Oct 2, 2026
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