At CIRA (and maybe NRL), we as developers are tasked with integrating established geospatial processing routines into GeoIPS, or as a standalone package that can interact with GeoIPS. For example, I've already created a standalone geoips_glm package which implements Global Lightning Mapper algorithms, GREMLIN Algorithms, and other functionality needed to produce outputs that match those created by non-geoips based code, achieving the same thing. The purpose of this issue is to create a documentation guideline for both developers and researchers, who will be working together to get their routines integrated to work alongside GeoIPS.
Background and Motivation
The motivation of this issue is to make it clear and easy for both developers and researchers to get software completely unrelated to GeoIPS to integrate with GeoIPS correctly. With this documentation created, developers will know if what they've created is accurate and working correctly, and researchers will know what to provide to developers to make this a streamlined process.
Checklist for Completion
Create a Documentation Guideline that highlights the process of getting proprietary code integrated with GeoIPS.
Should include the following to produce the desired outputs.
[ ] Datasets
[ ] Code; any of (algorithms, colormaps, readers, utils, and anything else needed to produce the desired output)
[ ] List of inputs needed to produce the desired outputs; examples [brightness_temperature, cwc, cloud_height, ...]
[ ] Accurate outputs from their own routines (so we can compare against what we've created; could include [images, netcdf files, ...]
[ ] A description which provides a general overview of what their software achieves, why it's needed, and what it outputs.
Requested Update
Description
At CIRA (and maybe NRL), we as developers are tasked with integrating established geospatial processing routines into GeoIPS, or as a standalone package that can interact with GeoIPS. For example, I've already created a standalone
geoips_glmpackage which implements Global Lightning Mapper algorithms, GREMLIN Algorithms, and other functionality needed to produce outputs that match those created by non-geoips based code, achieving the same thing. The purpose of this issue is to create a documentation guideline for both developers and researchers, who will be working together to get their routines integrated to work alongside GeoIPS.Background and Motivation
The motivation of this issue is to make it clear and easy for both developers and researchers to get software completely unrelated to GeoIPS to integrate with GeoIPS correctly. With this documentation created, developers will know if what they've created is accurate and working correctly, and researchers will know what to provide to developers to make this a streamlined process.
Checklist for Completion
Create a Documentation Guideline that highlights the process of getting proprietary code integrated with GeoIPS. Should include the following to produce the desired outputs.
algorithms,colormaps,readers,utils, and anything else needed to produce the desired output)brightness_temperature,cwc,cloud_height, ...]images,netcdf files, ...]