diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..0e09bf26dd008002666aebafdcf57e61eb4bec3c --- /dev/null +++ b/.gitignore @@ -0,0 +1,147 @@ +# Created by .ignore support plugin (hsz.mobi) +### Python template +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +### Vim template +# Swap +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +*~ +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + diff --git a/README.md b/README.md index c3535266a741eccba2abdf11562bb46aff621439..50fa8c9a7a55ee4e25cbb964b18d916d14a6144b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ -# cspp-geo-gridded-glm +# CSPP Geo Gridded GLM -CSPP Geo Gridded GLM package which wraps the glmtools python package and provides a command line interface. \ No newline at end of file +CSPP Geo Gridded GLM is a command line package to convert GOES-R series +Geostationary Lightning Mapper (GLM) data to a GOES-R ABI fixed grid. This +package wraps the open source python package "glmtools" created by Eric +Bruning. For more information on "glmtools" see its +[GitHub page](https://github.com/deeplycloudy/glmtools). + +Each portion of this repository is described in their own README files. diff --git a/build_package/README.md b/build_package/README.md new file mode 100644 index 0000000000000000000000000000000000000000..77eecd61298d321e7644801503870126e8ceed46 --- /dev/null +++ b/build_package/README.md @@ -0,0 +1,8 @@ +# Gridded GLM Package Build + +This directory contains scripts and files needed to build the CSPP Geo +Gridded GLM packaged from an existing buildbucket docker image. + +## Build Instructions + +TODO \ No newline at end of file diff --git a/buildbucket/README.md b/buildbucket/README.md new file mode 100644 index 0000000000000000000000000000000000000000..81c20bf47d4186a684760f2d755fec782a47e6c9 --- /dev/null +++ b/buildbucket/README.md @@ -0,0 +1,8 @@ +# Build Bucket + +This directory contains all the information to create a base build +environment for the Gridded GLM tool. + +## Built Bucket Creation Instructions + +TODO \ No newline at end of file diff --git a/gridded_glm/README.md b/gridded_glm/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6f8364aa0e6ddaa3528cd1cb3df27d21ab623510 --- /dev/null +++ b/gridded_glm/README.md @@ -0,0 +1,8 @@ +# Gridded GLM Package + +This directory contains scripts and other utilities included in the CSPP Geo +Gridded GLM package. + +## Usage + +TODO \ No newline at end of file