Skip to content

Conversation

@romanc
Copy link
Collaborator

@romanc romanc commented Aug 8, 2025

Description

This PR suggests to rename the following environment variables:

  • PACE_DACE_DEBUG -> NDSL_DACE_DEBUG
  • PACE_LOGLEVEL -> NDSL_LOGLEVEL
  • PACE_FLOAT_PRECISION -> NDSL_LITERAL_PRECISION
  • PACE_CONSTANTS -> NDSL_CONSTANTS

All changes are made backwards compatible (for now) with deprecation warnings when using PACE_* environment variables. NDSL_* variables will take precedence in case both variants are defined.

This Pr will influence #192 because we touch PACE_FLOAT_PRECISION there too.

How Has This Been Tested?

By self-review of code changes and by running the CI.

Checklist:

  • 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
    No, but that's kind of the point here 😉
  • Any dependent changes have been merged and published in downstream modules: N/A
  • New check tests, if applicable, are included: N/A

@romanc romanc marked this pull request as ready for review August 8, 2025 14:53
@romanc romanc changed the title RFC: Deprecate PACE_* environment variables in favor of NDSL_* Deprecate PACE_* environment variables in favor of NDSL_* Aug 8, 2025
@romanc
Copy link
Collaborator Author

romanc commented Aug 8, 2025

No opposition in today's pace meeting. Let's move ahead with this proposal.

/cc @FlorianDeconinck FYI for awareness when you are back

Copy link

@bensonr bensonr left a comment

Choose a reason for hiding this comment

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

Besides my one inline comment regarding documentation, the logic is ready.

twicki
twicki previously approved these changes Aug 8, 2025
Copy link
Collaborator

@twicki twicki left a comment

Choose a reason for hiding this comment

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

Looks great. Do we want an issue with this that we don't forget to move from deprication to removal of the variables in the future?

@romanc
Copy link
Collaborator Author

romanc commented Aug 11, 2025

Do we want an issue with this that we don't forget to move from deprecation to removal of the variables in the future?

Good idea. Tracked in issue #196.

@romanc romanc marked this pull request as draft August 11, 2025 08:47
@romanc
Copy link
Collaborator Author

romanc commented Aug 11, 2025

Putting this back to draft because PR #192 (to be merged first) introduces docs that we'll need to update.

@romanc romanc marked this pull request as ready for review August 11, 2025 15:11
@romanc
Copy link
Collaborator Author

romanc commented Aug 11, 2025

Putting this back to draft because PR #192 (to be merged first) introduces docs that we'll need to update.

We can also merge this one first and then update #192. We'll merge this one now to test the merge queue (now that #194 is merged). PR #192 will stay open for people to leave comments on the new docs added.

@romanc romanc added this pull request to the merge queue Aug 11, 2025
Merged via the queue into NOAA-GFDL:develop with commit 4fe14db Aug 11, 2025
5 checks passed
@romanc romanc deleted the romanc/env-vars-ndsl branch August 11, 2025 15:29
jjuyeonkim pushed a commit to jjuyeonkim/NDSL that referenced this pull request Sep 8, 2025
…FDL#193)

* Deprecate PACE_DACE_DEBUG in favor of NDSL_DACE_DEBUG

* Deprecate PACE_LOGLEVEL in favor of NDSL_LOGLEVEL

* Deprecate PACE_FLOAT_PRECISION in favor of NDSL_LITERAL_PRECISION

* Deprecate PACE_CONSTANTS in favor of NDSL_CONSTANTS

* Don't use ndsl_log before it is defined

* Document correctly renamed env variable

---------

Co-authored-by: Roman Cattaneo <[email protected]>
romanc added a commit to romanc/PySHiELD that referenced this pull request Sep 12, 2025
The old ones are currently deprecated and expected to be removed in
the future (after a grace period). See
NOAA-GFDL/NDSL#193 for more details.
romanc added a commit to romanc/pace that referenced this pull request Sep 12, 2025
The old ones are currently deprecated and expected to be removed
in the future (after a grace period). See
NOAA-GFDL/NDSL#193 for more details.
github-merge-queue bot pushed a commit to NOAA-GFDL/pace that referenced this pull request Sep 12, 2025
The old ones are currently deprecated and expected to be removed
in the future (after a grace period). See
NOAA-GFDL/NDSL#193 for more details.

Co-authored-by: Roman Cattaneo <[email protected]>
github-merge-queue bot pushed a commit to NOAA-GFDL/PySHiELD that referenced this pull request Sep 15, 2025
The old ones are currently deprecated and expected to be removed in
the future (after a grace period). See
NOAA-GFDL/NDSL#193 for more details.

Co-authored-by: Roman Cattaneo <[email protected]>
Co-authored-by: Oliver Elbert <[email protected]>
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