pyrocb 1.18.1__py3-none-any.whl

pyrocb/__init__.py

@@ -0,0 +1,14 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""
+Pyrocb is a GeoIPS-compatible plugin.
+
+The pyrocb plugin provides the capability for identifying and plotting
+pyrocumulonimbus using GOES ABI data.
+"""
+
+# NOTE: _version.py is generated automatically during build/install
+from ._version import __version__, __version_tuple__
+
+__all__ = ["__version__", "__version_tuple__"]

pyrocb/_version.py

@@ -0,0 +1,7 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+# DO NOT EDIT
+# managed by poetry-dynamic-versioning
+__version__ = "1.18.1"
+__version_tuple__ = (1, 18, 1)

pyrocb/plugins/__init__.py

@@ -0,0 +1,4 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Init file."""

pyrocb/plugins/modules/__init__.py

@@ -0,0 +1,4 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Init file."""

pyrocb/plugins/modules/algorithms/__init__.py

@@ -0,0 +1,4 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Init file."""

pyrocb/plugins/modules/algorithms/diff_10um_11um.py

@@ -0,0 +1,55 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Data manipulation steps for IR Window BT difference algorithm."""
+
+import logging
+
+import xarray
+
+LOG = logging.getLogger(__name__)
+
+interface = "algorithms"
+family = "xarray_to_xarray"
+name = "diff_10um_11um"
+
+
+def call(
+    xobj,
+    variables,
+    product_name="Window-Diff-10um-11um",
+):
+    """Algorithm for producing brightness temperature differences.
+
+    Originally used for the split window 10 um - 11 um BT difference for pyroCb
+    analysis of pyroCb detection potential. The channels used to calculate the
+    difference should be specified in a product YAML
+    (e.g. pyrocb/plugins/yaml/products/abi.yaml) in the order that there are to
+    be differenced (i.e. "variables: ['B13BT', 'B14BT']" in the product spec will
+    produce B14BT - B15BT).
+
+    Parameters
+    ----------
+    xobj : xarray.Dataset
+        * Xarrays containing 10 and 11 um brightness temperature data.
+    variables : list of str
+        * List of variables in the dataset.
+    product_name : str
+        * Name of product to be produced.
+
+    Returns
+    -------
+    xarray
+        * Modified xarray with IR difference added.
+    """
+    chan1_name = variables[0]  # B13BT (10 um)
+    chan2_name = variables[1]  # B14BT (11 um)
+
+    chan1_data = xobj[chan1_name].to_masked_array()
+    chan2_data = xobj[chan2_name].to_masked_array()
+
+    ir_diff = chan1_data - chan2_data
+
+    xobj[product_name] = xarray.DataArray(ir_diff)
+
+    return xobj

pyrocb/plugins/modules/algorithms/diff_10um_12um.py

@@ -0,0 +1,55 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Data manipulation steps for IR Window BT difference algorithm."""
+
+import logging
+
+import xarray
+
+LOG = logging.getLogger(__name__)
+
+interface = "algorithms"
+family = "xarray_to_xarray"
+name = "diff_10um_12um"
+
+
+def call(
+    xobj,
+    variables,
+    product_name="Window-Diff-10um-12um",
+):
+    """Algorithm for producing brightness temperature differences.
+
+    Originally used for the split window 10 um - 12 um BT difference for pyroCb
+    analysis of pyroCb detection potential. The channels used to calculate the
+    difference should be specified in a product YAML
+    (e.g. pyrocb/plugins/yaml/products/abi.yaml) in the order that there are to
+    be differenced (i.e. "variables: ['B13BT', 'B15BT']" in the product spec will
+    produce B14BT - B15BT).
+
+    Parameters
+    ----------
+    xobj : xarray.Dataset
+        * Xarrays containing 10 and 12 um brightness temperature data.
+    variables : list of str
+        * List of variables in the dataset.
+    product_name : str
+        * Name of product to be produced.
+
+    Returns
+    -------
+    xarray
+        * Modified xarray with IR difference added.
+    """
+    chan1_name = variables[0]  # B13BT (10 um)
+    chan2_name = variables[1]  # B15BT (12 um)
+
+    chan1_data = xobj[chan1_name].to_masked_array()
+    chan2_data = xobj[chan2_name].to_masked_array()
+
+    ir_diff = chan1_data - chan2_data
+
+    xobj[product_name] = xarray.DataArray(ir_diff)
+
+    return xobj

pyrocb/plugins/modules/algorithms/diff_11um_12um.py

@@ -0,0 +1,57 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Data manipulation steps for IR Window BT difference algorithm."""
+
+import logging
+
+import xarray
+
+LOG = logging.getLogger(__name__)
+
+interface = "algorithms"
+family = "xarray_to_xarray"
+name = "diff_11um_12um"
+
+
+def call(
+    xobj,
+    variables,
+    product_name,
+):
+    """Algorithm for producing brightness temperature differences.
+
+    Originally used for the split window 11 um - 12 um BT difference for pyroCb
+    analysis of pyroCb detection potential. The channels used to calculate the
+    difference should be specified in a product YAML
+    (e.g. pyrocb/plugins/yaml/products/abi.yaml) in the order that there are to
+    be differenced (i.e. "variables: ['B14BT', 'B15BT']" in the product spec will
+    produce B14BT - B15BT).
+
+    Parameters
+    ----------
+    xobj : xarray.Dataset
+        * Xarrays containing 11 and 12 um brightness temperature data.
+    variables : list of str
+        * List of variables in the dataset.
+    product_name : str
+        * Name of product to be produced.
+
+    Returns
+    -------
+    xarray
+        * Modified xarray with IR difference added.
+    """
+    if not product_name:
+        product_name = "Window-Diff-11um-12um"
+    chan1_name = variables[0]  # B14BT (11 um)
+    chan2_name = variables[1]  # B15BT (12 um)
+
+    chan1_data = xobj[chan1_name].to_masked_array()
+    chan2_data = xobj[chan2_name].to_masked_array()
+
+    ir_diff = chan1_data - chan2_data
+
+    xobj[product_name] = xarray.DataArray(ir_diff)
+
+    return xobj

pyrocb/plugins/modules/algorithms/diff_11um_13um.py

@@ -0,0 +1,55 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Data manipulation steps for 4-11um Window BT difference algorithm."""
+
+import logging
+
+import xarray
+
+LOG = logging.getLogger(__name__)
+
+interface = "algorithms"
+family = "xarray_to_xarray"
+name = "diff_11um_13um"
+
+
+def call(
+    xobj,
+    variables,
+    product_name="Window-Diff-11um-13um",
+):
+    """Algorithm for producing brightness temperature differences.
+
+    Originally used for the split window 11 um - 13 um BT difference for pyroCb
+    analysis of pyroCb detection potential. The channels used to calculate the
+    difference should be specified in a product YAML
+    (e.g. pyrocb/plugins/yaml/products/abi.yaml) in the order that there are to
+    be differenced (i.e. "variables: ['B14BT', 'B16BT']" in the product spec will
+    produce B14BT - B16BT).
+
+    Parameters
+    ----------
+    xobj : xarray.Dataset
+        * Xarrays containing 4 and 11 um brightness temperature data.
+    variables : list of str
+        * List of variables in the dataset.
+    product_name : str
+        * Name of product to be produced.
+
+    Returns
+    -------
+    xarray
+        * Modified xarray with IR difference added.
+    """
+    chan1_name = variables[0]  # B14BT (11 um)
+    chan2_name = variables[1]  # B16BT (13 um)
+
+    chan1_data = xobj[chan1_name].to_masked_array()
+    chan2_data = xobj[chan2_name].to_masked_array()
+
+    ir_diff = chan1_data - chan2_data
+
+    xobj[product_name] = xarray.DataArray(ir_diff)
+
+    return xobj

pyrocb/plugins/modules/algorithms/diff_4um_11um.py

@@ -0,0 +1,55 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Data manipulation steps for 4-11um Window BT difference algorithm."""
+
+import logging
+
+import xarray
+
+LOG = logging.getLogger(__name__)
+
+interface = "algorithms"
+family = "xarray_to_xarray"
+name = "diff_4um_11um"
+
+
+def call(
+    xobj,
+    variables,
+    product_name="Window-Diff-4um-11um",
+):
+    """Algorithm for producing brightness temperature differences.
+
+    Originally used for the split window 4 um - 11 um BT difference for pyroCb
+    analysis of pyroCb detection potential. The channels used to calculate the
+    difference should be specified in a product YAML
+    (e.g. pyrocb/plugins/yaml/products/abi.yaml) in the order that there are to
+    be differenced (i.e. "variables: ['B07BT', 'B14BT']" in the product spec will
+    produce B07BT - B14BT).
+
+    Parameters
+    ----------
+    xobj : xarray.Dataset
+        * Xarrays containing 4 and 11 um brightness temperature data.
+    variables : list of str
+        * List of variables in the dataset.
+    product_name : str
+        * Name of product to be produced.
+
+    Returns
+    -------
+    xarray
+        * Modified xarray with IR difference added.
+    """
+    chan1_name = variables[0]  # B07BT (4 um)
+    chan2_name = variables[1]  # B14BT (11 um)
+
+    chan1_data = xobj[chan1_name].to_masked_array()
+    chan2_data = xobj[chan2_name].to_masked_array()
+
+    ir_diff = chan1_data - chan2_data
+
+    xobj[product_name] = xarray.DataArray(ir_diff)
+
+    return xobj