diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..90b48ec --- /dev/null +++ b/.flake8 @@ -0,0 +1,12 @@ +[flake8] +max-line-length=88 +count=True +ignore=E203,W503,E712 +extend-exclude=_version.py,lib,*_docs,geoips_dev_utils +docstring-convention=numpy +rst-roles=class,func,ref +rst-directives=envvar,exception +rst-substitutions=version +statistics=True +per-file-ignores = + /*/interfaces/__init__.py:F401 diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..c35a451 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,60 @@ +changelog: + categories: + - title: Breaking Changes 🛠 + labels: + - "breaking change" + - "api change" + - "deprecation" + - title: Security Updates + labels: + - "security" + - title: Exciting New Features 🎉 + labels: + - "enhancement" + - "new functionality" + - "new feature" + - title: Deprecations + labels: + - "deprecation" + - title: Regression Fixes + labels: + - "regression" + - title: Bug Fixes + labels: + - "bug" + - title: Efficiency Improvements + labels: + - "efficiency" + - title: Installation Updates + labels: + - "installation" + - title: Real-time Processing Improvements + labels: + - "real-time processing" + - title: Code Formatting / Style / Refactoring Updates + labels: + - "formatting" + - "refactor" + - title: GitHub Actions Updates + labels: + - "actions" + - title: Git Workflow Improvements + labels: + - "git workflow" + - title: Testing Updates + labels: + - "testing" + - "code checks" + - "test repo updates" + - title: Documentation Updates + labels: + - "documentation" + - title: Changes During Release Process + labels: + - "Version Release" + - title: Developmental Updates + labels: + - "Dev Update" + - title: Other Changes + labels: + - "*" diff --git a/.github/workflows/brassy-notes.yaml b/.github/workflows/brassy-notes.yaml new file mode 100644 index 0000000..d91e01c --- /dev/null +++ b/.github/workflows/brassy-notes.yaml @@ -0,0 +1,25 @@ +name: Brassy + +on: + # Triggers the workflow when pull request closed (either closed + # as non-planned, or actually approved and merged.) + pull_request: + types: + - closed + branch: main + # Allows run of this workflow manually from the Actions tab + # Must be merged to default before it will be available to manually run. + workflow_dispatch: + +jobs: + brassy-notes: + name: Brassy + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-brassy-notes.yaml@main + # Only run this if the pull request was merged, not just closed. + if: github.event.pull_request.merged == true + permissions: + contents: write + pull-requests: write + secrets: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml new file mode 100644 index 0000000..b321882 --- /dev/null +++ b/.github/workflows/deploy-docs.yaml @@ -0,0 +1,36 @@ +name: Deploy docs + +# 1. Brassy - on merge of v*-version-release +# * generate release notes +# * commit and push to v*-add-rst-release-note +# * open PR to default branch +# 2. Tag and Release - on merge of v*-add-rst-release-note +# * Tag current version +# * Release just tagged version +# 3. Package and Publish - on published release (from #2) +# * Build wheel +# * Publish to pypi +# 4. Deploy docs - on published release (from #2) +# * pip install geoips +# * pip install plugin repo +# * build docs with geoips/docs/build_docs.sh +# * deploy docs with geoips/docs/deploy_pages.sh + +on: + # Triggers the workflow on published release + release: + types: + - published + # Allows run of this workflow manually from the Actions tab + # Must be merged to default before it will be available to manually run. + workflow_dispatch: + +jobs: + deploy-docs: + name: Deploy docs + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-deploy-docs.yaml@main + permissions: + contents: write + secrets: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..0d450e4 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,18 @@ +name: Lint + +# Only run linting on pull requests +on: + # Triggers the workflow when pull request created and updated + pull_request: + # Allows run of this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + lint: + name: Lint + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-lint.yaml@main + permissions: + contents: read + secrets: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/package-and-publish.yaml b/.github/workflows/package-and-publish.yaml new file mode 100644 index 0000000..0332742 --- /dev/null +++ b/.github/workflows/package-and-publish.yaml @@ -0,0 +1,38 @@ +name: Package/publish + +# 1. Brassy - on merge of v*-version-release +# * generate release notes +# * commit and push to v*-add-rst-release-note +# * open PR to default branch +# 2. Tag and Release - on merge of v*-add-rst-release-note +# * Tag current version +# * Release just tagged version +# 3. Package and Publish - on published release (from #2) +# * Build wheel +# * Publish to pypi +# 4. Deploy docs - on published release (from #2) +# * pip install geoips +# * pip install plugin repo +# * build docs with geoips/docs/build_docs.sh +# * deploy docs with geoips/docs/deploy_pages.sh + +on: + # triggers the workflow on published release + release: + types: + - published + # allows run of this workflow manually from the actions tab + # must be merged to default before it will be available to manually run. + workflow_dispatch: + +jobs: + package-publish: + name: Package/publish + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-package-and-publish.yaml@main + permissions: + contents: read + secrets: + token: ${{ secrets.GITHUB_TOKEN }} + pypi_user: ${{ secrets.PYPI_USER }} + pypi_password: ${{ secrets.PYPI_PASSWORD }} diff --git a/.github/workflows/proper-release-note-edits.yaml b/.github/workflows/proper-release-note-edits.yaml new file mode 100644 index 0000000..9b08747 --- /dev/null +++ b/.github/workflows/proper-release-note-edits.yaml @@ -0,0 +1,16 @@ +name: Note edits + +# We only need to check status of release notes from pull requests. +on: + # Triggers the workflow when pull request created and updated + pull_request: + # Allows run of this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + note-edits: + name: Note edits + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-proper-release-note-edits.yaml@main + permissions: + contents: read diff --git a/.github/workflows/tag-and-release.yaml b/.github/workflows/tag-and-release.yaml new file mode 100644 index 0000000..f8a1e23 --- /dev/null +++ b/.github/workflows/tag-and-release.yaml @@ -0,0 +1,25 @@ +name: Tag/release + +on: + # Triggers the workflow when pull request closed (either closed + # as non-planned, or actually approved and merged.) + pull_request: + types: + - closed + branch: main + # Allows run of this workflow manually from the Actions tab + # Must be merged to default branch before it will be available + # to manually run. + workflow_dispatch: + +jobs: + tag-release: + name: Tag/release + # You do not appear to be able to use variables in the "uses" field. + uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-tag-and-release.yaml@main + # Only run this if the pull request was merged, not just closed. + if: github.event.pull_request.merged == true + permissions: + contents: write + secrets: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index 240e0c9..0754fbb 100644 --- a/.gitignore +++ b/.gitignore @@ -3,18 +3,18 @@ # auto-downloaded test datasets tests/data/** - -# directory for profiling outputs -profiling/ -*.pstats +# auto-generated command instructions file +geoips/commandline/ancillary_info/cmd_instructions.json +# auto-generated alias mapping file for the cli +geoips/commandline/ancillary_info/alias_mapping.json #################################################### # GeoIPS Environment specific .gitignore options: -# auto-generated command instructions file -geoips/commandline/ancillary_info/cmd_instructions.json -# auto-generated release note file for latest changes -docs/source/releases/latest.rst +# auto-generated release note files, all release note information +# is stored in .yaml format and the rst files auto-generated. +# index.rst, latest.rst, v*.rst +docs/source/releases/*.rst # auto-generated plugin registry file registered_plugins.json # auto-generated version file, created at run-time @@ -31,6 +31,10 @@ _version.py *.swp *.simg +# directory for profiling outputs +profiling/ +*.pstats + #################################################### # Default auto-generated .gitignore options: diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1ede8cd..93be05f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,24 +1,9 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Please see https://github.com/NRLMMD-GEOIPS/geoips/blob/main/CHANGELOG_TEMPLATE.rst for instructions on updating release notes appropriately with each PR. - -The release note that is currently, actively being updated in -all geoips plugin repositories is referenced in the file: - -* https://github.com/NRLMMD-GEOIPS/geoips/blob/main/update_this_release_note - -* Please add all release notes for the current PR in the file referenced - within ``update_this_release note``. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4f5536f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,100 @@ + # # # This source code is protected under the license referenced at + # # # https://github.com/NRLMMD-GEOIPS. + +# Contributor Covenant Code of Conduct + +Code of Conduct only applicable for github.com. + +This Code of Conduct is maintained and enforced by our community collaborators, +and not the Federal Government and its employees. + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement via our contact +information at `docs/source/new-docs/contact.rst`. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Enforcement guidelines have been removed. Discussion is required to determine +how we will handle enforcement. In the mean time, we will endeavor to abide by +the Enforcement Responsibilities described above. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/DISTRIBUTION b/DISTRIBUTION index 5c7ac8a..f6733ee 100644 --- a/DISTRIBUTION +++ b/DISTRIBUTION @@ -1,11 +1 @@ -Distribution Statement A. Approved for public release. Distribution unlimited. - -Author: -Naval Research Laboratory, Marine Meteorology Division - -This program is free software: you can redistribute it and/or modify it under -the terms of the NRLMMD License included with this program. This program is -distributed WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -for more details. If you did not receive the license, for more information see: -https://github.com/U-S-NRL-Marine-Meteorology-Division/ +Distribution Statement A. Approved for public release. Distribution is unlimited. diff --git a/LICENSE b/LICENSE index 4b6eb5a..9ad9ee4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,36 +1,128 @@ -AUTHORIZATION TO USE AND DISTRIBUTE -I hereby agree to the following terms governing the use and redistribution of -the Geolocated Information Processing System (GeoIPS(R)) software release -originally written and developed by the Naval Research Laboratory Marine -Meteorology Division. - -To the extent that a federal employee is an author of a portion of this -software or a derivative work thereof, no copyright is claimed by the United -States Government, as represented by the Secretary of the Navy ("GOVERNMENT") -under Title 17, U.S. Code. All Other Rights Reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met -(1) source code distributions retain the above copyright notice, this list -of conditions, and the following disclaimer in its entirety, -(2) distributions including binary code include this paragraph in its entirety -in the documentation or other materials provided with the distribution, and -(3) all published research using this software display the following -acknowledgment: "This work uses the GeoIPS(R) software package written and -developed by the Naval Research Laboratory Marine Meteorology Division." - -Neither the name of NRL or its contributors, nor any entity of the United -States Government may be used to endorse or promote products derived from this -software, nor does the inclusion of the NRL written and developed software -directly or indirectly suggest NRL's or the United States Government's -endorsement of this product. - -THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED -WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. - -Notice of Third Party Software Licenses -This software contains open source software packages from third parties. -These are available on an .as is. basis and subject to their individual license -agreements. +NRL OPEN LICENSE AGREEMENT +1. Scope and Applicability: This Agreement applies to Computer Software that +is made available under this Agreement. By using, modifying, or disseminating +the Computer Software, You accept the terms and conditions in this Agreement. +Use, modification, and dissemination of the Computer Software is permitted +only in accordance with the terms and conditions of this Agreement. No other +rights or licenses to the Computer Software are granted. Unauthorized use, +sale, conveyance, disposition, or modification of a Computer Software may +result in civil penalties and/or criminal penalties under 18 U.S.C. § 641. + + +2. For purposes of this Agreement, the following definitions apply: + +a. “Computer software” means computer programs, source code, source code +listings, object code listings, design details, algorithms, processes, +flow charts, formulae, and related material that would enable the software +to be reproduced, recreated, or recompiled. + +b. “Derivative work” is a work based upon some or all of the Computer Software. + +c. “Unlimited rights” means rights to use, modify, reproduce, release, +perform, display, or disclose, in whole or in part, in any manner and for +any purpose whatsoever, and to have or authorize others to do so. + +d. “You” means yourself and any corporation, company, association, firm, +partnership, society, and joint stock company to which you are an employee, +volunteer, or an independent contractor performing services therefor. + +3. Use and Distribution License: The Government of the United States of +America (“Government”) hereby authorizes You to use and modify the Computer +Software for any purpose. The Government hereby authorizes You to +redistribute the Computer Software, but only under the terms of this +Agreement. You agree that any modifications to and derivative works of the +Computer Software generated by You shall be distributed only under the terms +of this Agreement. You shall provide a copy of this Agreement with any +distribution of the Computer Software, or any modification to and derivative +works of the Computer Software. + +4. Ownership: All Computer Software is property of the Government and under +the custody and administration of the U.S. Naval Research Laboratory (NRL). +Nothing in the Agreement shall be construed to constitute a sale, assignment, +or transfer of ownership to You of the Computer Software. + +5. Markings: You shall not remove any copyright notices, disclaimers, notices +of Government sponsorship and license rights, third-party licenses, and any +other identifications, contained in the Computer Software or provided in a +file accompanying the Computer Software, such as a license file. + +6. Header File Required: For source code provided under this Agreement, the +header of each source file shall contain the following statement: + +!####################################################################### + +THIS SOURCE CODE IS PROPERTY OF THE GOVERNMENT OF THE UNITED STATES OF +AMERICA. BY USING, MODIFYING, OR DISSEMINATING THIS SOURCE CODE, YOU ACCEPT +THE TERMS AND CONDITIONS IN THE NRL OPEN LICENSE AGREEMENT. USE, MODIFICATION, +AND DISSEMINATION ARE PERMITTED ONLY IN ACCORDANCE WITH THE TERMS AND +CONDITIONS OF THE NRL OPEN LICENSE AGREEMENT. NO OTHER RIGHTS OR LICENSES +ARE GRANTED. UNAUTHORIZED USE, SALE, CONVEYANCE, DISPOSITION, OR MODIFICATION +OF THIS SOURCE CODE MAY RESULT IN CIVIL PENALTIES AND/OR CRIMINAL PENALTIES +UNDER 18 U.S.C. § 641. + +!######################################################################## + +7. Government Rights: In consideration of making the Computer Software +available to You, You irrevocably grant the Government, at no cost, unlimited +rights in any and all modifications to, and derivative works of, the Computer +Software. Upon request, You shall deliver to NRL, or another Federal component +or agency as NRL may designate, all modifications to and derivative works of +the Computer Software generated by You or that are in Your possession. + +8. ALL MATERIAL IS PROVIDED “AS IS” AND WITHOUT ANY REPRESENTATION OR +WARRANTY, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY PARTICULAR PURPOSE +OR ANY WARRANTIES OF ACCURACY OR COMPLETENESS OR ANY WARRANTIES THAT THE +USE OF THE COMPUTER SOFTWARE WILL NOT INFRINGE OR VIOLATE ANY PATENT OR +OTHER PROPRIETARY RIGHTS OF ANY THIRD PARTY (WHETHER DIRECTLY OR INDIRECTLY). + +9. Notice: You shall provide prominent notice on any derivative work of the +Computer Software, or in a file accompanying the Computer Software, that the +Computer Software was developed in part or in whole by NRL. + +10. No Support. The Computer Software(s) is provided without any support or +maintenance, and without any obligation to provide modifications, +improvements, enhancements, or updates thereto. No oral or written +information or advice given by Federal employees shall create a warranty +or in any way modify this Agreement. + +11. Export Control: This Agreement does not authorize any disclosure, export, +or deemed export of technical information, articles, or services, nor does it +authorize or approve the use of any exemption to the export licensing +requirements of the International Traffic in Arms Regulations (“ITAR”) or the +Export Administration Regulations (“EAR”). You shall ensure full compliance +with all applicable requirements and restrictions established in law and +regulation pertaining to United States export controls including the Arms +Export Control Act, the International Traffic in Arms Regulations, the Export +Control Reform Act, the Export Administration Regulations, and the Atomic +Energy Act. + +12. Termination: The Government, either through NRL or another Federal +component or agency, may terminate this Agreement at any time. The Government +rights under Section 7 shall survive termination. + +13. Liability: You shall be solely liable for all claims and/or damages which +may arise from Your use, storage or disposal of the Computer Software under +this Agreement. Nothing in this Agreement shall be construed as a waiver of +the sovereign immunity of the United States. + +14. Indemnification: You agree on behalf of Yourself, and any successors in +interest or assignees of You, to hold harmless and indemnify the United States +from any claim for damages or injury to any person or property arising out of +the provision of the Computer Software. This will include any costs relating +to infringing a third party’s intellectual property rights. + +15. Governing Law & Jurisdiction. If a dispute, controversy, or claim relating +to this Agreement shall arise, You agree to first attempt to settle such +matter through informal dispute resolution. If any such matter cannot be +resolved informally, applicable U.S. Federal laws shall govern this Agreement +for all purposes. + +16. No Government Endorsement: You shall not make or include any statements +that imply NRL or another component or agency of the Federal Government +endorses You, Your work, or any product or service You offer. + +17. Severability. If any provision or term of this Agreement is held to be +invalid by a court of competent jurisdiction, then such provision or term +will be enforced to the maximum extent possible and the remaining terms of +this Agreement will continue in full force and effect. diff --git a/README.md b/README.md index e4baccb..c17b94e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,5 @@ - # # # Distribution Statement A. Approved for public release. Distribution unlimited. - # # # - # # # Author: - # # # Naval Research Laboratory, Marine Meteorology Division - # # # - # # # This program is free software: you can redistribute it and/or modify it under - # # # the terms of the NRLMMD License included with this program. This program is - # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - # # # for more details. If you did not receive the license, for more information see: - # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ + # # # This source code is protected under the license referenced at + # # # https://github.com/NRLMMD-GEOIPS. CLAVR-x GeoIPS Plugin Package ============================= diff --git a/bandit.yml b/bandit.yml new file mode 100644 index 0000000..c316793 --- /dev/null +++ b/bandit.yml @@ -0,0 +1,2 @@ +exclude: + - build/ diff --git a/docs/archive/CHANGELOG.md b/docs/archive/CHANGELOG.md index a496a1f..93e7d6c 100644 --- a/docs/archive/CHANGELOG.md +++ b/docs/archive/CHANGELOG.md @@ -1,14 +1,5 @@ - # # # Distribution Statement A. Approved for public release. Distribution unlimited. - # # # - # # # Author: - # # # Naval Research Laboratory, Marine Meteorology Division - # # # - # # # This program is free software: you can redistribute it and/or modify it under - # # # the terms of the NRLMMD License included with this program. This program is - # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - # # # for more details. If you did not receive the license, for more information see: - # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ + # # # This source code is protected under the license referenced at + # # # https://github.com/NRLMMD-GEOIPS. # v1.6.2: 2023-01-31, Initial release diff --git a/docs/source/geoips_clavrx_api/index.rst b/docs/source/geoips_clavrx_api/index.rst index 70dbbbc..dfe40cd 100644 --- a/docs/source/geoips_clavrx_api/index.rst +++ b/docs/source/geoips_clavrx_api/index.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. .. _api: diff --git a/docs/source/introduction/index.rst b/docs/source/introduction/index.rst deleted file mode 100644 index 7ae0305..0000000 --- a/docs/source/introduction/index.rst +++ /dev/null @@ -1,18 +0,0 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ - -************ -Introduction -************ - -.. toctree:: - :maxdepth: 2 diff --git a/docs/source/releases/1.14.0/1.14.0.yaml b/docs/source/releases/1.14.0/1.14.0.yaml new file mode 100644 index 0000000..e5ffe92 --- /dev/null +++ b/docs/source/releases/1.14.0/1.14.0.yaml @@ -0,0 +1,12 @@ +Release Process: +- title: Add 1.14.0 release note + description: | + *From GEOIPS#562: 2024-09-10, 1.14.0 updates* + + Currently tagged version 1.14.0. + files: + added: + - docs/source/releases/latest/1.14.0.yaml + deleted: + - docs/source/releases/index.rst + - docs/source/release/upcoming/1.14.1.yaml diff --git a/docs/source/releases/latest/666-final-bug-fixes-prior-to-workshop-2.yaml b/docs/source/releases/1.14.0/666-final-bug-fixes-prior-to-workshop-2.yaml similarity index 100% rename from docs/source/releases/latest/666-final-bug-fixes-prior-to-workshop-2.yaml rename to docs/source/releases/1.14.0/666-final-bug-fixes-prior-to-workshop-2.yaml diff --git a/docs/source/releases/latest/666-final-bug-fixes-prior-to-workshop.yaml b/docs/source/releases/1.14.0/666-final-bug-fixes-prior-to-workshop.yaml similarity index 83% rename from docs/source/releases/latest/666-final-bug-fixes-prior-to-workshop.yaml rename to docs/source/releases/1.14.0/666-final-bug-fixes-prior-to-workshop.yaml index 8ada236..209ea26 100644 --- a/docs/source/releases/latest/666-final-bug-fixes-prior-to-workshop.yaml +++ b/docs/source/releases/1.14.0/666-final-bug-fixes-prior-to-workshop.yaml @@ -2,7 +2,7 @@ documentation: - description: "Finalize README so installation process works correctly." title: "Add create_plugin_registries and missing test data to README" related-issue: | - *From GEOIPS/geoips#666: 2024-07-15, bug fixes prior to workshop* + *From GEOIPS#666: 2024-07-15, bug fixes prior to workshop* files: modified: - "README.md" @@ -12,7 +12,7 @@ release: this release note. title: "Add release note for v1.14.0a0" related-issue: | - *From GEOIPS/geoips#666: 2024-07-15, bug fixes prior to workshop* + *From GEOIPS#666: 2024-07-15, bug fixes prior to workshop* files: modified: - "docs/source/releases/v1_14_0a0.rst" @@ -26,7 +26,7 @@ installation: md file, and doc build now supports md to rst. title: "Update to standard installation setup" related-issue: | - *From GEOIPS/geoips#666: 2024-07-15, bug fixes prior to workshop* + *From GEOIPS#666: 2024-07-15, bug fixes prior to workshop* files: modified: - ".gitignore" diff --git a/docs/source/releases/1.14.1/1.14.1-ci-sync-updates.yaml b/docs/source/releases/1.14.1/1.14.1-ci-sync-updates.yaml new file mode 100644 index 0000000..6e3cf63 --- /dev/null +++ b/docs/source/releases/1.14.1/1.14.1-ci-sync-updates.yaml @@ -0,0 +1,12 @@ +Release Process: +- title: Update geoips_ci/sync files + description: | + *From GEOIPS#562: 2024-09-26, 1.14.1 updates* + files: + modified: + - .github/workflows/brassy-notes.yaml + - .github/workflows/deploy-docs.yaml + - .github/workflows/lint.yaml + - .github/workflows/package-and-publish.yaml + - .github/workflows/tag-and-release.yaml + - .gitignore diff --git a/docs/source/releases/1.14.1/1.14.1-release-note.yaml b/docs/source/releases/1.14.1/1.14.1-release-note.yaml new file mode 100644 index 0000000..228aaf2 --- /dev/null +++ b/docs/source/releases/1.14.1/1.14.1-release-note.yaml @@ -0,0 +1,17 @@ +documentation: + - title: Add release note for version 1.14.1 + description: | + *From GEOIPS#562: 2024-09-26, 1.14.1 updates* + + Release note on release branch to force tag/release, package/publish, + and deploy docs. + + Additionally add any updated files from geoips_ci/sync + files: + added: + - docs/source/releases/latest/1.14.1-release-note.yaml + modified: + - geoips_ci/sync updated files + related-issue: + number: 562 + repo_url: GEOIPS diff --git a/docs/source/releases/index.rst b/docs/source/releases/index.rst deleted file mode 100644 index 96254ff..0000000 --- a/docs/source/releases/index.rst +++ /dev/null @@ -1,61 +0,0 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ - -.. _release_notes: - -************* -Release Notes -************* - -Version 1.12 ------------- - -.. toctree:: - :maxdepth: 1 - - v1_12_2 - v1_12_2a0 - v1_12_1 - -Version 1.11 ------------- - -.. toctree:: - :maxdepth: 1 - - v1_11_7 - v1_11_7a0 - v1_11_3 - v1_11_3a0 - v1_11_0 - -Version 1.10 ------------- - -.. toctree:: - :maxdepth: 1 - - v1_10_3 - v1_10_2 - v1_10_0 - v1_10_0a3 - v1_10_0a2 - v1_10_0a1 - v1_10_0a0 - -Version 1.9 ------------ - -.. toctree:: - :maxdepth: 1 - - v1_9_1 diff --git a/docs/source/releases/v1_10_0.rst b/docs/source/releases/v1_10_0.rst index b48a008..c3f7325 100644 --- a/docs/source/releases/v1_10_0.rst +++ b/docs/source/releases/v1_10_0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.0 (2023-05-17) *************************** diff --git a/docs/source/releases/v1_10_0a0.rst b/docs/source/releases/v1_10_0a0.rst index e96c902..b87bc11 100644 --- a/docs/source/releases/v1_10_0a0.rst +++ b/docs/source/releases/v1_10_0a0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.0a0 (2023-04-28) ***************************** diff --git a/docs/source/releases/v1_10_0a1.rst b/docs/source/releases/v1_10_0a1.rst index cb6db11..5b87b67 100644 --- a/docs/source/releases/v1_10_0a1.rst +++ b/docs/source/releases/v1_10_0a1.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.0a1 (2023-04-29) ***************************** diff --git a/docs/source/releases/v1_10_0a2.rst b/docs/source/releases/v1_10_0a2.rst index ac39e1f..546e89f 100644 --- a/docs/source/releases/v1_10_0a2.rst +++ b/docs/source/releases/v1_10_0a2.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.0a2 (2023-05-04) ***************************** diff --git a/docs/source/releases/v1_10_0a3.rst b/docs/source/releases/v1_10_0a3.rst index c89d9ef..58d3f94 100644 --- a/docs/source/releases/v1_10_0a3.rst +++ b/docs/source/releases/v1_10_0a3.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.0a3 (2023-05-11) ***************************** diff --git a/docs/source/releases/v1_10_2.rst b/docs/source/releases/v1_10_2.rst index e9ec31f..a3e3cc9 100644 --- a/docs/source/releases/v1_10_2.rst +++ b/docs/source/releases/v1_10_2.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.2 (2023-06-13) *************************** diff --git a/docs/source/releases/v1_10_3.rst b/docs/source/releases/v1_10_3.rst index 9c4a24b..aee2cb5 100644 --- a/docs/source/releases/v1_10_3.rst +++ b/docs/source/releases/v1_10_3.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.10.3 (2023-07-24) *************************** diff --git a/docs/source/releases/v1_11_0.rst b/docs/source/releases/v1_11_0.rst index 28f9ca3..f7150b2 100644 --- a/docs/source/releases/v1_11_0.rst +++ b/docs/source/releases/v1_11_0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.11.0 (2023-08-09) *************************** @@ -39,3 +32,4 @@ Updates supporting geoips build_docs and ghpages deploy scripts modified: geoips_clavrx/plugins/yaml/products/clavrx.yaml modified: tests/test_all.sh + diff --git a/docs/source/releases/v1_11_3.rst b/docs/source/releases/v1_11_3.rst index 8449476..8878066 100644 --- a/docs/source/releases/v1_11_3.rst +++ b/docs/source/releases/v1_11_3.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.11.3 (2023-09-22) *************************** diff --git a/docs/source/releases/v1_11_3a0.rst b/docs/source/releases/v1_11_3a0.rst index 422813a..c22c12a 100644 --- a/docs/source/releases/v1_11_3a0.rst +++ b/docs/source/releases/v1_11_3a0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.11.3a0 (2023-08-24) ***************************** diff --git a/docs/source/releases/v1_11_7.rst b/docs/source/releases/v1_11_7.rst index 89efc92..04a46ab 100644 --- a/docs/source/releases/v1_11_7.rst +++ b/docs/source/releases/v1_11_7.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.11.7 (2023-11-09) *************************** diff --git a/docs/source/releases/v1_11_7a0.rst b/docs/source/releases/v1_11_7a0.rst index 5b9a2ef..1f40635 100644 --- a/docs/source/releases/v1_11_7a0.rst +++ b/docs/source/releases/v1_11_7a0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.11.7a0 (2023-10-27) ***************************** diff --git a/docs/source/releases/v1_12_1.rst b/docs/source/releases/v1_12_1.rst index 500fc35..02f9ce1 100644 --- a/docs/source/releases/v1_12_1.rst +++ b/docs/source/releases/v1_12_1.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.12.1 (2024-01-16) *************************** diff --git a/docs/source/releases/v1_12_2.rst b/docs/source/releases/v1_12_2.rst index e2a9155..a61483f 100644 --- a/docs/source/releases/v1_12_2.rst +++ b/docs/source/releases/v1_12_2.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.12.2 (2024-04-24) ************************************** diff --git a/docs/source/releases/v1_12_2a0.rst b/docs/source/releases/v1_12_2a0.rst index ae91ed5..e2ad7dd 100644 --- a/docs/source/releases/v1_12_2a0.rst +++ b/docs/source/releases/v1_12_2a0.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.12.2a0 (2024-02-12) ***************************** diff --git a/docs/source/releases/v1_9_1.rst b/docs/source/releases/v1_9_1.rst index a3a0b2e..344b4c0 100644 --- a/docs/source/releases/v1_9_1.rst +++ b/docs/source/releases/v1_9_1.rst @@ -1,14 +1,7 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +.. dropdown:: Distribution Statement + + | # # # This source code is protected under the license referenced at + | # # # https://github.com/NRLMMD-GEOIPS. Version 1.9.1 (2023-04-21) ************************** diff --git a/docs/source/userguide/index.rst b/docs/source/userguide/index.rst deleted file mode 100644 index 0634634..0000000 --- a/docs/source/userguide/index.rst +++ /dev/null @@ -1,18 +0,0 @@ - | # # # Distribution Statement A. Approved for public release. Distribution unlimited. - | # # # - | # # # Author: - | # # # Naval Research Laboratory, Marine Meteorology Division - | # # # - | # # # This program is free software: you can redistribute it and/or modify it under - | # # # the terms of the NRLMMD License included with this program. This program is - | # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of - | # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license - | # # # for more details. If you did not receive the license, for more information see: - | # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ - -********** -User Guide -********** - -.. toctree:: - :maxdepth: 2 diff --git a/geoips_clavrx/__init__.py b/geoips_clavrx/__init__.py index 664f5c3..2f94a20 100644 --- a/geoips_clavrx/__init__.py +++ b/geoips_clavrx/__init__.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """GeoIPS CLAVR-x plugin.""" diff --git a/geoips_clavrx/_version.py b/geoips_clavrx/_version.py index 523e541..7e16564 100644 --- a/geoips_clavrx/_version.py +++ b/geoips_clavrx/_version.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution is unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. # DO NOT EDIT # managed by poetry-dynamic-versioning diff --git a/geoips_clavrx/plugins/__init__.py b/geoips_clavrx/plugins/__init__.py index 37702cb..52e44a2 100644 --- a/geoips_clavrx/plugins/__init__.py +++ b/geoips_clavrx/plugins/__init__.py @@ -1,13 +1,4 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Plugins init file.""" diff --git a/geoips_clavrx/plugins/modules/__init__.py b/geoips_clavrx/plugins/modules/__init__.py index 992300a..92d5204 100644 --- a/geoips_clavrx/plugins/modules/__init__.py +++ b/geoips_clavrx/plugins/modules/__init__.py @@ -1,13 +1,4 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Modules init file.""" diff --git a/geoips_clavrx/plugins/modules/colormappers/__init__.py b/geoips_clavrx/plugins/modules/colormappers/__init__.py index cafc811..b090eed 100644 --- a/geoips_clavrx/plugins/modules/colormappers/__init__.py +++ b/geoips_clavrx/plugins/modules/colormappers/__init__.py @@ -1,13 +1,4 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Colormaps init file.""" diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_IR.py b/geoips_clavrx/plugins/modules/colormappers/cmap_IR.py index f87e0d2..b77277e 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_IR.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_IR.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Colormap for IR Brightness Temperatures.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldFraction.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldFraction.py index 8905082..9ceb887 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldFraction.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldFraction.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Satellite cloud fraction product colormap.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldHeight.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldHeight.py index 88a5de1..1549e6d 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldHeight.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldHeight.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for cloud Height product.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldMask.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldMask.py index 3aed32e..4b9e574 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldMask.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldMask.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for satellite cloud mask products.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldOpd.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldOpd.py index e3a6655..db0c9f8 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldOpd.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldOpd.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for satellite cloud optical depth products.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldPhase.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldPhase.py index dccf1ca..8d13f02 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldPhase.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldPhase.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for satellite cloud phase products.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldReff.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldReff.py index fa07d84..4b1aaad 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldReff.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldReff.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for effective radius of cloud particles product.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldTemp.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldTemp.py index f41b582..ed8b671 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldTemp.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldTemp.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for cloud top temperature product.""" import logging diff --git a/geoips_clavrx/plugins/modules/colormappers/cmap_cldType.py b/geoips_clavrx/plugins/modules/colormappers/cmap_cldType.py index 453b04b..f25f734 100644 --- a/geoips_clavrx/plugins/modules/colormappers/cmap_cldType.py +++ b/geoips_clavrx/plugins/modules/colormappers/cmap_cldType.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Module containing colormap for satellite cloud type products.""" import logging diff --git a/geoips_clavrx/plugins/modules/readers/__init__.py b/geoips_clavrx/plugins/modules/readers/__init__.py index b083f32..1c40dd4 100644 --- a/geoips_clavrx/plugins/modules/readers/__init__.py +++ b/geoips_clavrx/plugins/modules/readers/__init__.py @@ -1,13 +1,4 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """Readers init file.""" diff --git a/geoips_clavrx/plugins/modules/readers/clavrx_hdf4.py b/geoips_clavrx/plugins/modules/readers/clavrx_hdf4.py index ddc176c..65e1e48 100644 --- a/geoips_clavrx/plugins/modules/readers/clavrx_hdf4.py +++ b/geoips_clavrx/plugins/modules/readers/clavrx_hdf4.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """ CLAVR-x hdf4 cloud property data reader. diff --git a/geoips_clavrx/plugins/modules/readers/clavrx_netcdf4.py b/geoips_clavrx/plugins/modules/readers/clavrx_netcdf4.py index 788c088..5e294af 100644 --- a/geoips_clavrx/plugins/modules/readers/clavrx_netcdf4.py +++ b/geoips_clavrx/plugins/modules/readers/clavrx_netcdf4.py @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. """CLAVR-x NetCDF4 Reader.""" import logging diff --git a/pyproject.toml b/pyproject.toml index a9938b4..f97389f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,16 +1,24 @@ [tool.poetry] -name = "geoips_clavrx" # package available at the root of the project -version = "0.0.0" -description = "geoips_clavrx GeoIPS Plugin Package" -authors = [] +# required ones +name = "geoips_clavrx" +version = "0.0.0" # 0.0.0 will be auto-updated with poetry dynamic versioning! +description = "Geolocated Information Processing System" +authors = ["GeoIPS "] + +# optional ones +maintainers = ["GeoIPS "] +#homepage = "set the url" // optional +repository = "https://github.com/NRLMMD-GEOIPS/geoips_clavrx" #optional +#documentation = "set the url" // optional +#license = {file = "LICENSE"} // required readme = "README.md" -keywords = [] -license = "LICENSE" # required +keywords = ["GeoIPS", "Poetry"] +packages = [ + { include = "geoips_clavrx" }, +] # not needed as tool.poetry.name is properly set already classifiers = [ # // list of PyPI trove classifiers to describe the project "Programming Language :: Python :: 3", ] -repository = "https://github.com/NRLMMD-GEOIPS/geoips_clavrx" #optional -#documentation = "set the url" include = ["**/*.txt", "**/*.py", "**/*.yaml"] # uses current version .postN and not incrementing @@ -18,23 +26,50 @@ include = ["**/*.txt", "**/*.py", "**/*.yaml"] enable = true vcs = "git" metadata = false # don't include local-version hash; date doesn't appear by deafult -style = "pep440" # pep440 is default; can rmeove later on; used for : keeping 0.0.8 as the default install until 0.0.9 is out +style = "pep440" # pep440 is deafult; can rmeove later on; used for : keeping 0.0.8 as the default install until 0.0.9 is out #style = "semver" #tag-branch = "feature-poetry" strict = false pattern = "(?x)^((?P\\d+)!)?(?P\\d+(\\.\\d+)*)([-._]?((?P[a-zA-Z]+)[-._]?(?P\\d+)?))?(\\+(?P.+))?$" +# NOTE: You must CREATE a _version.py file and commit it via git! +# That file will have 0.0.0 as the version - which will get updated when +# pip installed. +# FURTHER NOTE: pip install -e will actually NOT update _version.py. +# if you must have a valid version in your local editable install (which +# is typically not necessary), you can manually update _version.py +# with the following steps: +# > pip install poetry-dynamic-versioning +# > poetry-dynamic-versioning +# (those steps are called automatically when running pip install, but +# NOT when running pip install -e) [tool.poetry-dynamic-versioning.substitution] files = ["*/_version.py"] # This is where you would specify a pre-build script from pyproject.toml/poetry. # [tool.poetry.build] # generate-setup-file = false # I have no idea what this does -# script = "build.py" # This gets called as a python script prior to running build steps +# script = prebuild.py # This gets called as a python script prior to running build steps [build-system] requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"] build-backend = "poetry_dynamic_versioning.backend" # object used to perform the build process +[tool.poetry.dependencies] # must download to run +python = ">=3.9" # mandatory to declare the required python version + +# Optional dependencies +# To add a new optional dependency it must be added both here and in one of the "extra" +# groups below. +# +# Build group +requests = { version = "*", optional = true } + +# NOTE system libjpeg also required, via conda +[tool.poetry.extras] +build = [ + "requests", +] + [tool.poetry.plugins."geoips.plugin_packages"] -"geoips_clavrx" = "geoips_clavrx" +geoips = "geoips_clavrx" diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..f2e21dd --- /dev/null +++ b/pytest.ini @@ -0,0 +1,5 @@ +[pytest] +addopts = -v -rf --ff --cov-report=term-missing +testpaths = + tests/unit_tests* +norecursedirs = xarray_utils \ No newline at end of file diff --git a/tests/scripts/abi.Cloud-Fraction.imagery_clean.sh b/tests/scripts/abi.Cloud-Fraction.imagery_clean.sh index 78da2e1..07ee803 100755 --- a/tests/scripts/abi.Cloud-Fraction.imagery_clean.sh +++ b/tests/scripts/abi.Cloud-Fraction.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Base-Height.imagery_clean.sh b/tests/scripts/ahi.Cloud-Base-Height.imagery_clean.sh index a02d740..573dde7 100755 --- a/tests/scripts/ahi.Cloud-Base-Height.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Base-Height.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Fraction.imagery_clean.sh b/tests/scripts/ahi.Cloud-Fraction.imagery_clean.sh index 578d2b5..e6617f8 100755 --- a/tests/scripts/ahi.Cloud-Fraction.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Fraction.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Mask.imagery_clean.sh b/tests/scripts/ahi.Cloud-Mask.imagery_clean.sh index 448aa11..38d673d 100755 --- a/tests/scripts/ahi.Cloud-Mask.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Mask.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Optical-Depth.imagery_clean.sh b/tests/scripts/ahi.Cloud-Optical-Depth.imagery_clean.sh index 4fafba1..6226e26 100755 --- a/tests/scripts/ahi.Cloud-Optical-Depth.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Optical-Depth.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Phase.imagery_clean.sh b/tests/scripts/ahi.Cloud-Phase.imagery_clean.sh index 21a2722..b68b7ce 100755 --- a/tests/scripts/ahi.Cloud-Phase.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Phase.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Temp-ACHA.imagery_clean.sh b/tests/scripts/ahi.Cloud-Temp-ACHA.imagery_clean.sh index 3cc7744..9f2964b 100755 --- a/tests/scripts/ahi.Cloud-Temp-ACHA.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Temp-ACHA.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Top-Height.imagery_clean.sh b/tests/scripts/ahi.Cloud-Top-Height.imagery_clean.sh index c6e9c3d..796ac26 100755 --- a/tests/scripts/ahi.Cloud-Top-Height.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Top-Height.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Cloud-Type.imagery_clean.sh b/tests/scripts/ahi.Cloud-Type.imagery_clean.sh index c95b05d..fde7988 100755 --- a/tests/scripts/ahi.Cloud-Type.imagery_clean.sh +++ b/tests/scripts/ahi.Cloud-Type.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Effective-Radius.imagery_clean.sh b/tests/scripts/ahi.Effective-Radius.imagery_clean.sh index 7b10a5f..050a33e 100755 --- a/tests/scripts/ahi.Effective-Radius.imagery_clean.sh +++ b/tests/scripts/ahi.Effective-Radius.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Temp-11p0.imagery_clean.sh b/tests/scripts/ahi.Temp-11p0.imagery_clean.sh index 1708cba..7c61a5e 100755 --- a/tests/scripts/ahi.Temp-11p0.imagery_clean.sh +++ b/tests/scripts/ahi.Temp-11p0.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/scripts/ahi.Temp-3p75.imagery_clean.sh b/tests/scripts/ahi.Temp-3p75.imagery_clean.sh index e706a13..5334bce 100755 --- a/tests/scripts/ahi.Temp-3p75.imagery_clean.sh +++ b/tests/scripts/ahi.Temp-3p75.imagery_clean.sh @@ -1,14 +1,5 @@ -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. #!/bin/bash diff --git a/tests/test_all.sh b/tests/test_all.sh index 9989576..8513a4f 100755 --- a/tests/test_all.sh +++ b/tests/test_all.sh @@ -1,16 +1,7 @@ #!/bin/bash -# # # Distribution Statement A. Approved for public release. Distribution unlimited. -# # # -# # # Author: -# # # Naval Research Laboratory, Marine Meteorology Division -# # # -# # # This program is free software: you can redistribute it and/or modify it under -# # # the terms of the NRLMMD License included with this program. This program is -# # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of -# # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license -# # # for more details. If you did not receive the license, for more information see: -# # # https://github.com/U-S-NRL-Marine-Meteorology-Division/ +# # # This source code is protected under the license referenced at +# # # https://github.com/NRLMMD-GEOIPS. # This should contain test calls to cover ALL required functionality tests for # this repo.