|
1 |
| -# unity_cumulus_lambda_functions |
| 1 | +<!-- Header block for project --> |
| 2 | +<hr> |
| 3 | + |
| 4 | +<div align="center"> |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +<h1 align="center">Unity Data Services</h1> |
| 9 | +<!-- ☝️ Replace with your repo name ☝️ --> |
| 10 | + |
| 11 | +</div> |
| 12 | + |
| 13 | +<pre align="center">This repository contains source code that handles data ingest, data catalog, data search and data access that complies to OGC DAPA and STAC specifications.</pre> |
| 14 | +<!-- ☝️ Replace with a single sentence describing the purpose of your repo / proj ☝️ --> |
| 15 | + |
| 16 | +<!-- Header block for project --> |
| 17 | + |
| 18 | +[](code_of_conduct.md) |
| 19 | +<!-- ☝️ Add badges via: https://shields.io e.g.  ☝️ --> |
| 20 | + |
| 21 | +<!-- ☝️ Screenshot of your software (if applicable) via  ☝️ --> |
| 22 | + |
| 23 | +This repository contains |
| 24 | +* Functions that parses metadata and is used within Cumulus workflows |
| 25 | +* Functions that invoke Cumulus API and implement OGC DAPA and STAC |
| 26 | +* Functions for data search and download through OGC DAPA and STAC |
| 27 | +* Functions for data ingest through OGC DAPA, STAC, and CNM |
| 28 | + |
| 29 | +<!-- ☝️ Replace with a more detailed description of your repository, including why it was made and whom its intended for. ☝️ --> |
| 30 | + |
| 31 | +[Unity Documentation](https://unity-sds.gitbook.io/docs/) | [Cumulus Documentation](https://nasa.github.io/cumulus/docs/cumulus-docs-readme) | [Issue Tracker](https://github.com/unity-sds/unity-data-services/issues) |
| 32 | +<!-- example links> |
| 33 | +[Website](INSERT WEBSITE LINK HERE) | [Docs/Wiki](INSERT DOCS/WIKI SITE LINK HERE) | [Discussion Board](INSERT DISCUSSION BOARD LINK HERE) | [Issue Tracker](INSERT ISSUE TRACKER LINK HERE) |
| 34 | +--> |
| 35 | + |
| 36 | +## Features |
| 37 | + |
| 38 | +* Data ingest |
| 39 | +* Data catalog (and metadata parsing) |
| 40 | +* Data search |
| 41 | +* Data access |
| 42 | + |
| 43 | +<!-- ☝️ Replace with a bullet-point list of your features ☝️ --> |
| 44 | + |
| 45 | +## Contents |
| 46 | + |
| 47 | +* [Quick Start](#quick-start) |
| 48 | +* [Changelog](#changelog) |
| 49 | +* [FAQ](#frequently-asked-questions-faq) |
| 50 | +* [Contributing Guide](#contributing) |
| 51 | +* [License](#license) |
| 52 | +* [Support](#support) |
| 53 | + |
| 54 | +## Quick Start |
| 55 | + |
| 56 | +Please visit our [quick-start](https://unity-sds.gitbook.io/docs/developer-docs/data/quick-start). |
| 57 | + |
| 58 | +### Requirements |
| 59 | + |
| 60 | +* Compliant with OGC DAPA specification |
| 61 | +* Compliant with STAC specification |
| 62 | + |
| 63 | +<!-- ☝️ Replace with a numbered list of your requirements, including hardware if applicable ☝️ --> |
| 64 | + |
| 65 | +### Setup Instructions |
| 66 | + |
| 67 | +Please visit our [developer guide](https://unity-sds.gitbook.io/docs/developer-docs/data/docs/developers-guide) for setup instructions. |
| 68 | + |
| 69 | +<!-- ☝️ Replace with a numbered list of how to set up your software prior to running ☝️ --> |
| 70 | + |
| 71 | +### Run Instructions |
| 72 | + |
| 73 | +Please visit our [developer guide](https://unity-sds.gitbook.io/docs/developer-docs/data/docs/developers-guide) for run instructions. |
| 74 | + |
| 75 | +<!-- ☝️ Replace with a numbered list of your run instructions, including expected results ☝️ --> |
| 76 | + |
| 77 | +### Usage Examples |
| 78 | + |
| 79 | +Please visit our [users guide](https://unity-sds.gitbook.io/docs/developer-docs/data/docs/users-guide) for usage examples. |
| 80 | + |
| 81 | +<!-- ☝️ Replace with a list of your usage examples, including screenshots if possible, and link to external documentation for details ☝️ --> |
| 82 | + |
| 83 | +### Build Instructions |
| 84 | + |
| 85 | +This repository is integrated with [GitHub Actions](https://github.com/unity-sds/unity-data-services/actions) for automated builds. |
| 86 | + |
| 87 | +<!-- ☝️ Replace with a numbered list of your build instructions, including expected results / outputs with optional screenshots ☝️ --> |
| 88 | + |
| 89 | +### Test Instructions |
| 90 | + |
| 91 | +Please visit our [developer guide](https://unity-sds.gitbook.io/docs/developer-docs/data/docs/developers-guide) for test instructions. |
| 92 | + |
| 93 | +<!-- ☝️ Replace with a numbered list of your test instructions, including expected results / outputs with optional screenshots ☝️ --> |
| 94 | + |
| 95 | +## Changelog |
| 96 | + |
| 97 | +See our [CHANGELOG.md](CHANGELOG.md) for a history of our changes. |
| 98 | + |
| 99 | +See our [releases page](https://github.com/unity-sds/unity-data-services/releases) for our key versioned releases. |
| 100 | + |
| 101 | +<!-- ☝️ Replace with links to your changelog and releases page ☝️ --> |
| 102 | + |
| 103 | +## Frequently Asked Questions (FAQ) |
| 104 | + |
| 105 | +https://unity-sds.gitbook.io/docs/developer-docs/data/faq |
| 106 | +<!-- example link to FAQ PAGE> |
| 107 | +Questions about our project? Please see our: [FAQ]([INSERT LINK TO FAQ / DISCUSSION BOARD]) |
| 108 | +--> |
| 109 | + |
| 110 | +<!-- example FAQ inline format> |
| 111 | +1. Question 1 |
| 112 | + - Answer to question 1 |
| 113 | +2. Question 2 |
| 114 | + - Answer to question 2 |
| 115 | +--> |
| 116 | + |
| 117 | +<!-- example FAQ inline with no questions yet> |
| 118 | +No questions yet. Propose a question to be added here by reaching out to our contributors! See support section below. |
| 119 | +--> |
| 120 | + |
| 121 | +<!-- ☝️ Replace with a list of frequently asked questions from your project, or post a link to your FAQ on a discussion board ☝️ --> |
| 122 | + |
| 123 | +## Contributing |
| 124 | + |
| 125 | +Interested in contributing to our project? Please see our: [CONTRIBUTING.md](CONTRIBUTING.md) |
| 126 | + |
| 127 | +## License |
| 128 | + |
| 129 | +See our: [LICENSE](LICENSE) |
| 130 | + |
| 131 | +## Support |
| 132 | + |
| 133 | +Key points of contact are: |
| 134 | + |
| 135 | +[@ngachung](https://github.com/ngachung) |
| 136 | +[@seanhardman](https://github.com/seanhardman) |
| 137 | +[@wphyojpl](https://github.com/wphyojpl) |
| 138 | + |
| 139 | +<!-- example list of contacts> |
| 140 | +Key points of contact are: [@github-user-1](link to github profile) [@github-user-2](link to github profile) |
| 141 | +--> |
| 142 | + |
| 143 | +<!-- ☝️ Replace with the key individuals who should be contacted for questions ☝️ --> |
| 144 | + |
0 commit comments