v1.12.0 Version Release #418

mindyls · 2023-12-27T03:27:33Z

Requested Update

Ready for review.

Description

This issue is created in order to track all repositories updated with the v1.12.0 release.
All repositories with changes staged for 1.12.0 release will be linked to this Issue.
Release process on each repository:
- Create branch: v1.12.0-release
- Create pull request from v1.12.0-release to main
- Tag/release v1.12.0 on main branch after PR merge

Once output of full_test.sh has been included under Test Outputs below,
(with all updated repos on the v1.12.0-version-release branch, and all other repos on main),
all Version Release PRs will be ready for merge.

Updated Repositories

ancildat
data_fusion
fortran_utils
geocolor
geoips
geoips_clavrx
geoips_plugin_example
geoips_tropics
lunarref
rayleigh
recenter_tc
ryglickicane
synth_green
template_basic_plugin
true_color

Testing Instructions

Install GeoIPS ( https://github.com/NRLMMD-GEOIPS/geoips#installation )
- You do not have to reinstall, but follow appropriate installation instructions if you do not have a current install
Enable GeoIPS environment
- Activate the Python environment containing GeoIPS installation.
- Ensure all required development environment variables are set
  - $GEOIPS_PACKAGES_DIR, $GEOIPS_REPO_URL, $GEOIPS_TESTDATA_DIR, $GEOIPS_OUTDIRS)
Switch to v1.12.0-release branch for geoips repo

git -C $GEOIPS_PACKAGES_DIR/geoips pull
git -C $GEOIPS_PACKAGES_DIR/geoips checkout v1.12.0-release

Get all of the geoips plugin packages and test data repos. Note the full install uses > 60G disk space and > 16G memory.

$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/base_install.sh  # Just the geoips repo
$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/full_install.sh  # All plugin packages and test data

Follow the below instructions to switch any repos with a 1.12.0 release branch to that branch:

source $GEOIPS_PACKAGES_DIR/geoips/setup/bash_setup/gitall  # convenience functions to run on all packages in $GEOIPS_PACKAGES_DIR
gitall pull  # make sure we have all the branches, etc available
gitall checkout main  # switch everything to main
gitall checkout v1.12.0-release  # this will switch anything with v1.12.0-release branch there, and do nothing otherwise
gitall pull  # make sure everything is up to date
pipall install -e .  # now install
create_plugin_registries  # create the geoips plugin registries

Run the base test, which will ensure the geoips base repository updates were successful:

$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/base_test.sh

Run the full test, which will ensure ALL GeoIPS plugin repositories were updated successfully (This will use a large amount of disk space and memory! If you are memory or disk space limited, only perform the base install and test)

$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/full_test.sh

Test Outputs

Include successful output here once release is complete:

$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/base_install.sh
$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/base_test.sh

Package: geoips_base
Total run time: 144 seconds
Number data types run: 3
Number data types failed: 0
Thu Jan  4 21:02:07 UTC 2024

$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/full_install.sh
$GEOIPS_PACKAGES_DIR/geoips/tests/integration_tests/full_test.sh

# 2 failures due to ascat test data repo not being updated yet.
# Additionally needed update to flake8 config for geoips flake8 tests to pass.
# Additionally, lunarref, geocolor, and true_color are not yet added to the full test.

Package: geoips_full
Total run time: 2744 seconds
Number data types run: 53
Number data types failed: 2
Thu Jan  4 20:01:45 UTC 2024

The text was updated successfully, but these errors were encountered:

…install workflows (#419) * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * Update black.yaml to use GEOIPS_ACTIVE_BRANCH To ensure the correct version of the geoips code base, reference the GEOIPS_ACTIVE_BRANCH organization variable. This allows updating the geoips branch to use for actions if updates are made to the workflows. * variables -> vars * Use v4 checkout * Update black.yaml * Update black.yaml * Update black.yaml * Update flake8.yaml for GEOIPS_ACTIVE_BRANCH * Update black.yaml to checkout v3 * Add .config to sparse-checkout * Add .config to sparse checkout * Turn on build docs html * Use org vars for runner, org * Turn off build-html-docs * Turn off pytest-short.yaml * Turn off test-interfaces.yaml * Updating black formatting from 1.12.0 release (#430) Co-authored-by: Mindy <none> --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com>

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

…ith 1.12.0 update (#19) 1.12.0 release NRLMMD-GEOIPS/geoips#418 Co-authored-by: mindyls <mindyls@users.noreply.github.com>

….0 update (#33) * 1.12.0 release NRLMMD-GEOIPS/geoips#418 * Removing no_flake8, has been resolved. Ensure we are testing flake8 compliance. --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com>

* fixed algorithm_interpolator_colormapper interpolation error * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * moved release notes to most current version v1_12_2a0.rst for this branch --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com>

* modified create_plugin_registries.py to use argparse instead of sys.argv * added docs for this branch * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * Update black.yaml to use GEOIPS_ACTIVE_BRANCH To ensure the correct version of the geoips code base, reference the GEOIPS_ACTIVE_BRANCH organization variable. This allows updating the geoips branch to use for actions if updates are made to the workflows. * variables -> vars * Use v4 checkout * Update black.yaml * Update black.yaml * Update black.yaml * Update flake8.yaml for GEOIPS_ACTIVE_BRANCH * Update black.yaml to checkout v3 * Add .config to sparse-checkout * Add .config to sparse checkout * Turn on build docs html * Use org vars for runner, org * Turn off build-html-docs * Turn off pytest-short.yaml * Turn off test-interfaces.yaml * Updating black formatting from 1.12.0 release (#430) Co-authored-by: Mindy <none> * Add help and description to CLI * Add missing paren * Black reformatting * moved release notes for this PR to most updated release v1_12_2a0.rst --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <jeremy.solbrig@colostate.edu>

* replaced log outputs with log_with_emphasis where applicable * replaced long ***... strings with multiplied * strings * added notes to release notes * black formatting changes * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * trying to get this branch back in order * new implementation of log_with_emphasis that sets a max length message per line * black formatting changes and static log_with_emphasis function implemented * update to black; new formatting changes applied * added unit test for log_with_emphasis * black formatting changes * updated release notes for this PR * flake8 changes for log_with_emphasis unit test * moved release notes for this branch to most current version v1_12_2a0.rst * remove test_log_interactive_non_geoips This test was problematic. It worked sometimes and not others. I decided it was better to just remove and not worry about polluting the logging class. Polluting the class doesn't actually hurt anything for anyone. * Move to correct file name * Fix docstring and imports * Add to changelog * Adding *** back in at beginning of message * Put it back, I think it broke black * updated log_with_emphasis function to accept one or more strings instead of a list of strings. Modified output to wrap messages differently * updated unit tests to reflect new changes made to log_with_emphasis function * made log_with_emphasis use python textwrap library and changed unit tests to reflect this * removed old emphasis log statements from output_checkers/netcdf.py * Update docstring for log_with_emphasis * Fix name of print_func * Ignore profiling stuff --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <jeremy.solbrig@colostate.edu>

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

* 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * figured out north pole bug, follow new viirs script to see what you need to do * Update black.yaml to use GEOIPS_ACTIVE_BRANCH To ensure the correct version of the geoips code base, reference the GEOIPS_ACTIVE_BRANCH organization variable. This allows updating the geoips branch to use for actions if updates are made to the workflows. * variables -> vars * Use v4 checkout * Update black.yaml * Update black.yaml * Update black.yaml * Update flake8.yaml for GEOIPS_ACTIVE_BRANCH * Update black.yaml to checkout v3 * Add .config to sparse-checkout * Add .config to sparse checkout * Turn on build docs html * Use org vars for runner, org * Turn off build-html-docs * Turn off pytest-short.yaml * Turn off test-interfaces.yaml * Updating black formatting from 1.12.0 release (#430) Co-authored-by: Mindy <none> * added to documentation updates made for polar imagery bug * implemented solid fix for polar sectoring bug * updated release notes to reflect status of this PR * new black formatting changes * moved v1_12_0.rst release notes to v1_12_2a0.rst release notes for this branch * refactored code in data.py and added unit tests for that refactoring * added release notes to this PR * Update v1_12_2a0.rst spelling mistake * black / flake8 formatting changes * added viirs north pole test script to test_all.sh --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com>

…mily' (#437) * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * Update black.yaml to use GEOIPS_ACTIVE_BRANCH To ensure the correct version of the geoips code base, reference the GEOIPS_ACTIVE_BRANCH organization variable. This allows updating the geoips branch to use for actions if updates are made to the workflows. * variables -> vars * Use v4 checkout * Update black.yaml * Update black.yaml * Update black.yaml * Update flake8.yaml for GEOIPS_ACTIVE_BRANCH * Update black.yaml to checkout v3 * Add .config to sparse-checkout * Add .config to sparse checkout * Turn on build docs html * Use org vars for runner, org * Turn off build-html-docs * Turn off pytest-short.yaml * Turn off test-interfaces.yaml * Updating black formatting from 1.12.0 release (#430) Co-authored-by: Mindy <none> * current status of function to list all available interfaces for each interface family * added release notes for this branch * new black formatting changes * moved release notes from v1_12_0.rst to v1_12_2a0.rst for this branch * Improve docstring --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <jeremy.solbrig@colostate.edu>

* 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * Update black.yaml to use GEOIPS_ACTIVE_BRANCH To ensure the correct version of the geoips code base, reference the GEOIPS_ACTIVE_BRANCH organization variable. This allows updating the geoips branch to use for actions if updates are made to the workflows. * variables -> vars * Use v4 checkout * Update black.yaml * Update black.yaml * Update black.yaml * Update flake8.yaml for GEOIPS_ACTIVE_BRANCH * Update black.yaml to checkout v3 * Add .config to sparse-checkout * Add .config to sparse checkout * Turn on build docs html * Use org vars for runner, org * Turn off build-html-docs * Turn off pytest-short.yaml * Turn off test-interfaces.yaml * Updating black formatting from 1.12.0 release (#430) Co-authored-by: Mindy <none> * added new context manager import function and applied it to readers that needed it. * added release notes for this update * black formatting changes and update to config based for optional dependencies * added last file changed to release notes * black formatting changes (github actions says it fails however it passes on my local branch * moved release updates from v1_12_0.rst to v1_12_2a0.rst * removed line from v1_12_0.rst that reflected changes in this branch * Update v1_12_2a0.rst Made underline fit Line Length of Version v1.12.2a0... * updated all optional imports and added unit tests for them * changed old path to new path to file in release notes * updated final optional dependencies to use import_optional_dependencies context manager * Update v1_12_2a0.rst to reflect new files changed added geoips/utils/memusg.py --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com>

* added this branch to the release notes * 1.12.0 release #418 * Removing unused comments * Update installation.rst * Update installation.rst * Update installation.rst * Add leading '/' to flake8 per-file-ignores Without the leading /, flake8 would fail from certain directories. Sometimes it would fail when running from within the repo, sometimes it would faile when running from OUTSIDE the repo. With the leading /, it seems to pass from anywhere. * moved release notes for this branch to most current version v1_12_2a0.rst * Copyedited documentation - Fixed grammar and spelling - Copyedited for clarity, brevity and flow - Added comments where further clarification is needed Related to Issue #386 and Pull request #400 * Improve clarity about performance increase 📝 On PR #400 I commented that the documentation for the pluginregistry functionality needed. I outlined 3 different changes that needed to be made. I was able to take care of concern 2: ``` The benefits section has a sentence which is difficult to understand without context. The performance increases are partly due to the new code "only instantiating the plugin registry when a user requests a plugin", but the previous behavior isn't detailed which makes it difficult to understand why (explicitly) this is an improvement. ``` 1 and 3 still need take care of: ``` The example is helpful, but needs to be more explicitly explained. Eg. walk the reader through the example "This line of the file ... because .. " ``` and ``` How does the plugin registry work? We are told why it's important, that it store info and some other details. But not explicitly what it does and how. ``` :slightly_smiling_face: :pencil: * Correct doc phrasing * Removing old human readable JSON release note * Rearranged release note * Fix typo, add missing word * Update plugin_registries.rst Replaced "encapsulate" with "represent the three available" * Add sphinxcontrib-autoprogram * Move parser creation to function * Reorganize * Add note about autobuilding registries * Add info about sphinxcontrib-autoprogram * Update v1_12_2a0.rst --------- Co-authored-by: mindyls <mindyls@users.noreply.github.com> Co-authored-by: mindyls <13873624+mindyls@users.noreply.github.com> Co-authored-by: Gwyn Uttmark <biosafetylevel5@gmail.com> Co-authored-by: BSL-5 <biosafetylvl5@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <1684491+jsolbrig@users.noreply.github.com> Co-authored-by: Jeremy Solbrig <jeremy.solbrig@colostate.edu>

mindyls added the Version Release Version Release Updates label Dec 27, 2023

mindyls self-assigned this Dec 27, 2023

mindyls added a commit that referenced this issue Dec 28, 2023

1.12.0 release #418

b08a4a4

mindyls mentioned this issue Dec 28, 2023

v1.12.0 geoips - VERSION RELEASE - plugin registry bug fixes, geoips install workflows #419

Merged

mindyls added a commit to NRLMMD-GEOIPS/data_fusion that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

ff8e001

mindyls mentioned this issue Jan 2, 2024

v1.12.0 data_fusion - VERSION RELEASE - separate identify_checker and get_plugin NRLMMD-GEOIPS/data_fusion#28

Merged

mindyls added a commit to NRLMMD-GEOIPS/geoips_clavrx that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

a68f6f2

mindyls mentioned this issue Jan 2, 2024

v1.11.7 geoips_clavrx - VERSION RELEASE - 1.11.7 re-release with 1.12.0 update NRLMMD-GEOIPS/geoips_clavrx#33

Merged

mindyls added a commit to NRLMMD-GEOIPS/geoips_plugin_example that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

7dcaf4c

mindyls mentioned this issue Jan 2, 2024

v1.11.7 geoips_plugin_example - VERSION RELEASE - 1.11.7 re-release with 1.12.0 update NRLMMD-GEOIPS/geoips_plugin_example#11

Merged

mindyls added a commit to NRLMMD-GEOIPS/geoips_tropics that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

fc04baf

mindyls mentioned this issue Jan 2, 2024

v1.12.0 geoips_tropics - VERSION RELEASE - timestamp->time, update 91 cmap NRLMMD-GEOIPS/geoips_tropics#2

Merged

mindyls added a commit to NRLMMD-GEOIPS/recenter_tc that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

5734766

mindyls mentioned this issue Jan 2, 2024

v1.11.7 recenter_tc - VERSION RELEASE - 1.11.7 re-release with 1.12.0 update NRLMMD-GEOIPS/recenter_tc#31

Merged

mindyls added a commit to NRLMMD-GEOIPS/template_basic_plugin that referenced this issue Jan 2, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418

420eaaf

mindyls mentioned this issue Jan 2, 2024

v1.11.7 template_basic_plugin - VERSION RELEASE - 1.11.7 re-release with 1.12.0 update NRLMMD-GEOIPS/template_basic_plugin#19

Merged

jsolbrig closed this as completed in #419 Feb 13, 2024

jsolbrig pushed a commit to NRLMMD-GEOIPS/geoips_plugin_example that referenced this issue Feb 13, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418 (#11)

b54df89

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

jsolbrig pushed a commit to NRLMMD-GEOIPS/data_fusion that referenced this issue Feb 13, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418 (#28)

5dbc4c8

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

jsolbrig pushed a commit to NRLMMD-GEOIPS/recenter_tc that referenced this issue Feb 13, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418 (#31)

75a89df

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

jsolbrig pushed a commit to NRLMMD-GEOIPS/geoips_tropics that referenced this issue Apr 12, 2024

1.12.0 release NRLMMD-GEOIPS/geoips#418 (#2)

9160d57

Co-authored-by: mindyls <mindyls@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v1.12.0 Version Release #418

v1.12.0 Version Release #418

mindyls commented Dec 27, 2023 •

edited

Loading

v1.12.0 Version Release #418

v1.12.0 Version Release #418

Comments

mindyls commented Dec 27, 2023 • edited Loading

Requested Update

Description

Updated Repositories

Testing Instructions

Test Outputs

mindyls commented Dec 27, 2023 •

edited

Loading