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

Pre-RC updates #1159

Merged
merged 20 commits into from
Nov 29, 2023
Merged

Pre-RC updates #1159

merged 20 commits into from
Nov 29, 2023

Conversation

aburrell
Copy link
Member

@aburrell aburrell commented Nov 27, 2023

Description

Addresses #1155 by comparing the package documents and tests to the ecosystem templates. Also:

  • Improves file handling in the package init,
  • Fixes call to importlib's metadata,
  • Updates the package citation, and
  • Removes and old TODO statement

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Ran unit tests locally. Also:

import pysat

pinst = pysat.Instrument('pysat', 'testing')
xinst = pysat.Instrument('pysat', 'ndtesting')
minst = pysat.Instrument('pysat', 'testmodel')
pinst.load(yr=2009, doy=1)
xinst.load(yr=2009, doy=1)
minst.load(yr=2009, doy=1)

# Printing 'longitude' for each instrument will show the range is 0-360. Change that
pysat.utils.coords.update_longitude(pinst, 'longitude')
pysat.utils.coords.update_longitude(xinst, 'longitude')
pysat.utils.coords.update_longitude(minst, 'longitude')

# Now -180-180
print(pinst['longitude'])
print(xinst['longitude'])
print(minst['longitude'])

Test Configuration:

  • Operating system: OS X Big Sur
  • 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 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 wiki: https://github.com/pysat/pysat/wiki/Checklist-for-Release

Updated the issue forms to be up to current standards.
Updated the pull request template to include all current check items.
Updated the CI yamls to be better formatted and contain the new coveralls logic.
Updated code of conduct to comply with style standards.
Updated contributing guidelines to include better formatting and recent updates to style.
Updated readme to include better installation instructions.
Removed the old citation file.
Fixed the metadata implementation and used the resources package where possible.
Updated the manifest to not include old files.
Updated requirements to:
- not include scipy (not imported anywhere), and
- move pytest to the test installation.
Address a TODO for closed issue #988, which should fix updating the data without separate calls for xarray or pandas type.
Updated the citation version and year.
Use the resources module to access the citation file, if possible.
Use the new module citation attribute.
Re-add the citation text file to the manifest.
Re-added the pytest requirement to the main code.
Fixed a bug in the xarray setitem magic method that did not account for native dimensions in the data when assigning arrays as values.
@aburrell aburrell added this to the 3.2.0 Release milestone Nov 27, 2023
@aburrell aburrell linked an issue Nov 27, 2023 that may be closed by this pull request
2 tasks
@aburrell aburrell mentioned this pull request Nov 27, 2023
2 tasks
Found where scipy was needed, re-adding dependency.
Fixed a bug in assigning new xarray data.
@aburrell aburrell merged commit 99308a2 into develop Nov 29, 2023
23 checks passed
@aburrell aburrell deleted the update_doc_standards_ver_alpha branch November 29, 2023 18:32
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.

Check standard docs for pysat
2 participants