Skip to content

Latest commit

 

History

History
140 lines (106 loc) · 5.52 KB

template_instructions.rst

File metadata and controls

140 lines (106 loc) · 5.52 KB
Raw
# # # 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:

Instructions for setting up repository from template

IMPORTANT NOTE: In all commands below, replace @package@ with the name that you want for your plugin package.

  1. Clone the template repository and push it to a repo of your own
    • Change to the GeoIPS packages directory (set during GeoIPS install).
      • cd $GEOIPS_PACKAGES_DIR
    • Clone this repo: git clone https://github.com/NRLMMD-GEOIPS/template_basic_plugin.git
    • Move to your package name: mv template_basic_plugin @package@
    • Create a git repository somewhere (e.g. github.com)
    • Move into your package repo: cd @package@
    • Set the repository URL to your new repository: git remote set-url origin <your repo URL>
    • Push to your new repository: git push -u origin main
  2. Update package subdirectory from my_package to @package@
    • git mv my_package @package@
    • git commit my_package @package@
  3. Update README.md with your appropriate package information.
    • cd to your package
    • Edit README.md
    • Replace @package@ with your actual package name (my_package_name):
      • :%s/@package@/my_package_name/gc
    • Search for '@' within the README and follow the included instructions to update appropriately.
    • Remove all lines containing '@'
    • git commit README.md
  4. Update pyproject.toml appropriately for new package name
    • Edit pyproject.toml
    • Update @package@ to package name
    • Add any python package dependencies to "install_requires"
    • git commit pyproject.toml
  5. Update/add yaml plugins in @package@/plugins/yaml with desired functionality.
  6. Update/add modules in @package@/plugins/modules with desired functionality.
  7. Update pyproject.toml appropriately for new Python module-based plugins
    • Edit pyproject.toml
    • Add any new interface modules to "entry_points" (every module added in the plugins/modules subdirectory will have an associated entry point in pyproject.toml)
    • Add any python package dependencies to "install_requires"
    • git commit pyproject.toml
  8. Add individual test scripts in @package@/tests/scripts/*.sh
    • amsr2.tc_clean.89-Test.sh is a direct single_source example command - this tests a single product for a single data type. You do not have to exhaustively test every piece of functionality with direct single source calls - but it can be nice to have one or 2 examples for reference. Name your test scripts appropriately.
    • test_config.yaml is called by test_config.sh to produce output for multiple products with a single call. Testing all products can be more efficiently performed using YAML output config testing vs direct single source calls.
    • These test scripts provide both examples of how the package is called via geoips, as well as a means of ensuring the processing continues to function as updates are made to external dependencies.
    • Rename / delete / add test scripts appropriately.
    • git commit tests/scripts
  9. Add all test scripts to @package@/tests/test_all.sh
    • Edit tests/test_all.sh
    • This script is called automatically during exhaustive geoips testing - requires 0 return.
    • Ensure all functionality included.
    • git commit tests/test_all.sh
  10. Add one example test script to README.md, if desired
    • Edit README.md
    • Add one direct test call to last section, "Test @package@ installation"
    • git commit README.md
  11. Update docs/source/releases/v0_1_0.rst with description of updates / included modules.
    • Edit docs/source/releases/v0_1_0.rst
    • Edit docs/source/releases/index.rst
    • git commit docs/source/releases/
  12. Make sure all new and updated files have been commited and pushed
    • git commit .
    • git push
  13. Remove this 'template_instructions.rst' file
    • git rm docs/template_instructions.rst
    • git commit docs/template_instructions.rst
    • git push