# # # 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/

Basic GeoIPS Plugin Template

This template repository contains everything necessary to create a fully compatible GeoIPS Plugin Package. Each file within this repository contains appropriate modification instructions.

To create your own functional plugin for GeoIPS, follow the step by step instructions for modifying the template files within this repo.

@ Once this repository has been set up properly, you can remove this "Basic GeoIPS Plugin Template" section in the README.md, leaving the appropriate content for your package's README file.

@package@ GeoIPS Plugin

The @package@ package is a GeoIPS-compatible plugin, intended to be used within the GeoIPS ecosystem. Please see the GeoIPS Documentation for more information on the GeoIPS plugin architecture and base infrastructure.

Package Overview

The @package@ plugin provides the capability for

@ Please include a brief description of what capability this package provides.

@ This section should be no more than 1-2 paragraphs, if you have additional @ information to include, please include in a "docs" subdirectory.

@ Example overview:

@ The template_basic_plugin package provides template files which can be used to create @ a fully compatible GeoIPS plugin. This template repository is focused on basic functionality - @ ie, simple readers, products, output formats, etc. Additional template repositories will be @ created for more sophisticated and complicated use cases.

System Requirements

• geoips >= 1.10.0
• Test data repos contained in $GEOIPS_TESTDATA_DIR for tests to pass.
• @ Add any additional system requirements, such as gfortran, etc

IF REQUIRED: Install base geoips package

SKIP IF YOU HAVE ALREADY INSTALLED BASE GEOIPS ENVIRONMENT

If GeoIPS Base is not yet installed, follow the installation instructions within the geoips source repo documentation:

Install @package@ package

    # Ensure GeoIPS Python environment is enabled.

    # Clone and install @package@
    git clone https://github.com/NRLMMD-GEOIPS/@package@ $GEOIPS_PACKAGES_DIR/@package@
    pip install -e $GEOIPS_PACKAGES_DIR/@package@

    # Add any additional clone/install/setup steps here

Test @package@ installation

    # Ensure GeoIPS Python environment is enabled.

    # This script will run ALL tests within this package
    $GEOIPS_PACKAGES_DIR/@package@/tests/test_all.sh

    # Individual direct test calls, for reference
    $GEOIPS_PACKAGES_DIR/@package@/tests/scripts/<test_script_name>.sh