Collection, aggregation, and cataloging of NOAA post-storm emergency response imagery.


Keywords
python
License
MIT
Install
pip install psi-collect==1.0.4

Documentation

Post-Storm Imagery Collection

PyPI Travis-CI Codecov Dependabot ReadTheDocs Last Commit JOSS

Collection, aggregation, and cataloging of NOAA post-storm emergency response imagery.

This package helps users (researchers, managers, etc.) download, analyze, and store aerial imagery taken after hurricane events that have impacted the USA.

Documentation

Team Members

Usage

Quick Start:

  1. Install Python 3.6, 3.7, or 3.8 (Download Here)
  2. Run pip3 install psi-collect in your favorite terminal
  3. Run pstorm collect -h for help on collecting images or pstorm catalog -h for help on cataloging local archives

Check out the documentation for Collecting and Cataloging images to see some examples

Contributing / Developing

Code of Conduct

We hope to foster an inclusive and respectful environment surrounding the contribution and discussion of our project. Make sure you understand our Code of Conduct.

Code Conventions

Before committing to the repository please read the project Code Conventions.

Project Pre-Requisites

  1. Python 3.6, 3.7, or 3.8 (Download Here)
  2. Pipenv (Run pip install pipenv)
  3. You will need to add the module path <parent dir>/psi-collect/psicollect/ to your PYTHONPATH (See Configuring Module)

If you get an error message that looks something like Module not found: "psicollect", then the PYTHONPATH is not configured correctly!

You will need this in order to run the project.

Installing Dependencies for Development

  1. Change current directory (cd) to psi-collect/ (the project root)
  2. Run pipenv install --dev to install dependencies
  3. Run pre-commit install to install style checking when committing

Testing the Collect Script

  1. Change current directory to the collector module (cd collector/)
  2. Either use pipenv run collect.py <args> or pipenv shell then collect.py <args>
  3. In addition tests can be run using pytest from the project root directory

The arguments for collect.py are listed here

Data Source 💾

  • NOAA landing page for the post-storm Emergency Response Imagery, here