# # # This source code is subject to the license referenced at
# # # https://github.com/NRLMMD-GEOIPS.

PyroCb GeoIPS Plugin

The pyrocb 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 pyrocb plugin provides the capability for identifying and plotting pyrocumulonimbus using GOES ABI data.

System Requirements

• geoips >= 1.18.0
• Test data repos contained in $GEOIPS_TESTDATA_DIR for tests to pass.
  • test_data_pyrocb
  • test_data_nucaps
  • test_data_ahi
• data fusion
• geoips_nucaps
• metpy

Installation Guide

This installation guide has installation steps specific to installing this plugin, including the base geoips conda install if not already installed.

IF REQUIRED: Install and test base geoips conda environment

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

Install pyrocb package and dependencies

    # Ensure GeoIPS Python environment is enabled.

    # Install pyrocb and geoips plugin package dependencies
    git clone https://github.com/NRLMMD-GEOIPS/data_fusion $GEOIPS_PACKAGES_DIR/data_fusion
    git clone https://github.com/NRLMMD-GEOIPS/geoips_nucaps $GEOIPS_PACKAGES_DIR/geoips_nucaps
    git clone https://github.com/NRLMMD-GEOIPS/pyrocb $GEOIPS_PACKAGES_DIR/pyrocb
    pip install -e $GEOIPS_PACKAGES_DIR/data_fusion
    pip install -e $GEOIPS_PACKAGES_DIR/geoips_nucaps
    pip install -e $GEOIPS_PACKAGES_DIR/pyrocb

Test pyrocb installation

    # Ensure GeoIPS Python environment is enabled.

    # Install required test data repositories.
    geoips config install test_data_pyrocb
    geoips config install test_data_nucaps
    geoips config install test_data_ahi

    # Test all functionality
    cd $GEOIPS_PACKAGES_DIR/pyrocb
    pytest

    # Individual direct test calls, for reference
    $GEOIPS_PACKAGES_DIR/pyrocb/tests/scripts/abi.sh PyroCb-Standard PCBCalNev
    $GEOIPS_PACKAGES_DIR/pyrocb/tests/scripts/abi.sh PyroCb-Standard PCBFourCorners
    $GEOIPS_PACKAGES_DIR/pyrocb/tests/scripts/abi_nucaps.sh PyroCb-Standard-NUCAPS PCBCalNev
    $GEOIPS_PACKAGES_DIR/pyrocb/tests/scripts/abi_nucaps.sh PyroCb-Standard-NUCAPS PCBFourCorners