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

RC 0.2.1 #46

Merged
merged 65 commits into from
Nov 18, 2024
Merged

RC 0.2.1 #46

merged 65 commits into from
Nov 18, 2024

Conversation

jklenzing
Copy link
Member

@jklenzing jklenzing commented Oct 4, 2024

Description

Release candidate. Updates compliance with pysat 3.2.x for unit tests, standards for community documents and actions.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

via GitHub Actions

Test Configuration:

  • Operating system: Windows, ubuntu, mac
  • Version number: Python 3.10, 3.11, 3.12

Checklist:

  • Update the version number
  • Verify and update Zenodo information in .zenodo.json
  • doc tests pass locally
  • activate this branch on readthedocs (include link here)
  • Upload the test distribution to the testPyPi server
  • Contacted developers and users about the future release
  • [na] Performed integration tests with downstream packages (include list of these packages)
  • Create a wiki page with the release text (put link here)
  • After approval, confirm all changes from the RC pull are listed in the wiki release text.
  • 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 pysat wiki:
https://github.com/pysat/pysat/wiki/Checklist-for-Release

@jklenzing jklenzing added this to the 0.2.1 Release milestone Oct 4, 2024
@jklenzing jklenzing marked this pull request as ready for review October 15, 2024 14:49
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.readthedocs.yml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Co-authored-by: Angeline Burrell <[email protected]>
@jklenzing jklenzing requested a review from aburrell November 7, 2024 19:00
CHANGELOG.md Outdated
@@ -2,6 +2,18 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.2.1] - 2024-11-01
Copy link
Member

Choose a reason for hiding this comment

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

Need to update release date.

CHANGELOG.md Outdated
@@ -2,6 +2,18 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.2.1] - 2024-11-01
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
## [0.2.1] - 2024-11-01
## [0.2.1] - 2024-11-15

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 for working to get this package up to speed and out of the proverbial dark ages.

- python-version: "3.8"
numpy_ver: "1.21"
# NEP29 compliance settings
- python-version: "3.10"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should maintain the same operational testing Python version for the pysatPenumbra packages as pysat does.

Copy link
Member

Choose a reason for hiding this comment

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

Hard disagree. Core pysat has different needs then the penumbra packages and should not dictate what each package in the ecosystem decides to do.

Copy link
Member Author

Choose a reason for hiding this comment

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

Historically, this package has never supported the operational env. I have limited time. If you would like to lead a pull for a future version, you are welcome to do so.

# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd prefer if we used the updated distribution statement thing going forward.

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

Copy link
Member

Choose a reason for hiding this comment

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

This can be an issue for the future.

acknowledgements.rst


.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

Suggested change
.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
.. admonition:: Review Status for Classified or Controlled Information by NRL
-------------------------------------------------------------
DISTRIBUTION STATEMENT A: Approved for public release.

The formatting lines up in the editing window. Not so much after it gets posted... :(

version = "0.2.1"
description = "Seasonal analysis routines for pysat"
readme = "README.md"
requires-python = ">=3.10"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment about minimum python version. I think the penumbra packages should maintain consistency with the pysat release requirements.

@@ -2,6 +2,10 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2022, pysat development team
# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

@@ -2,6 +2,10 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2022, pysat development team
# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

self.bounds1 = (dt.datetime(2008, 1, 1), dt.datetime(2008, 1, 3))
self.bounds2 = (dt.datetime(2009, 1, 1), dt.datetime(2009, 1, 2))

return


class TestFrameProfileAverages(object):
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the currently listed minimum supported pysat version still has these alternate formats....
I've forgotten exactly when those were removed though.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed in 3.2.0. Updating the minimum to streamline.

@@ -2,6 +2,10 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2022, pysat development team
# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

@@ -2,6 +2,10 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2022, pysat development team
# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

@@ -2,6 +2,10 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2022, pysat development team
# Full license can be found in License.md
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# Review Status for Classified or Controlled Information by NRL
# -------------------------------------------------------------
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is

@jklenzing jklenzing requested a review from rstoneback November 15, 2024 15:09
@jklenzing jklenzing merged commit 82a76e0 into main Nov 18, 2024
25 of 27 checks passed
@jklenzing jklenzing deleted the rc0_2_1 branch November 18, 2024 20:11
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.

3 participants