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

ENH: updates GNSS tec documentation, methods testing #58

Merged
merged 11 commits into from
Sep 20, 2021

Conversation

aburrell
Copy link
Member

@aburrell aburrell commented Sep 15, 2021

Description

Improves the GNSS methods testing, adds a TEC example, and expands general Madrigal metadata definitions. Also fully defines the GNSS VTEC metadata. Partially addresses #3 and #41.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality or documentation)
  • This change requires a documentation update

How Has This Been Tested?

Created an example in the docs and added unit tests. You should also now receive no warning when loading VTEC data.

Test Configuration

  • Operating system: OS X Mojave
  • Version number: Python 3.9
  • 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

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

Improved the general load routine's definition of the meta data.
Replaced the VTEC figure while creating example text.
Updated the definitions of the VTEC metadata to remove load warnings.
Added an example for plotting VTEC maps to the docs.
Added unit tests for the GNSS methods routines.
Added description of these changes to the changelog.
Improved the style by removing unused imports and variables, as well as cleaning up whitespace.
@aburrell aburrell added documentation Improvements or additions to documentation enhancement New feature or request testing labels Sep 15, 2021
This was linked to issues Sep 15, 2021
@aburrell aburrell added this to the 0.1.0 Release milestone Sep 15, 2021
aburrell and others added 2 commits September 15, 2021 13:56
Updated the test class style by adding a class type and a `return` statement to all methods.
Copy link
Collaborator

@rstoneback rstoneback left a comment

Choose a reason for hiding this comment

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

Thanks @aburrell!

docs/examples/ex_gnss_tec.rst Outdated Show resolved Hide resolved
docs/examples/ex_gnss_tec.rst Outdated Show resolved Hide resolved
meta.labels.min_val: np.nan, meta.labels.max_val: np.nan}
meta['gdalt'] = {meta.labels.min_val: 0.0, meta.labels.max_val: np.nan}
meta['gdlat'] = {meta.labels.min_val: -90.0, meta.labels.max_val: 90.0}
min_lon = 0.0 if data['glon'].values.min() >= 0.0 else -180.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do the longitudes differ across files?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not yet... but it seemed silly to not check for something that varies regularly from file iteration to file iteration and is very simple to verify.

@rstoneback
Copy link
Collaborator

rstoneback commented Sep 16, 2021

Not required, and it probably makes the example too complicated for the docs, but it would be nice if we could get coastlines on the VTEC plot as well.

aburrell and others added 2 commits September 20, 2021 09:01
Added `plt.show()` to a plotting example.

Co-authored-by: Russell Stoneback <rstoneba@utdallas.edu>
Fixed a bug in the download example.

Co-authored-by: Russell Stoneback <rstoneba@utdallas.edu>
@aburrell
Copy link
Member Author

Yeah, I decided against it because I didn't want to figure out carteopy or get carteopy questions in the future 🗺️

Copy link
Collaborator

@rstoneback rstoneback left a comment

Choose a reason for hiding this comment

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

Thanks @aburrell!

@aburrell aburrell merged commit 252a9aa into develop Sep 20, 2021
@aburrell aburrell deleted the doc_gnss_update branch September 20, 2021 20:13
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 enhancement New feature or request testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: add more examples TST: Expand instrument method coverage
2 participants