-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- link to documentation site - add high-level contribution instructions - remove dataset documentation in favor of documentation site
- Loading branch information
1 parent
d14ac88
commit 973c3dd
Showing
1 changed file
with
11 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,21 @@ | ||
# geo-datasets | ||
|
||
Dataset ingest pipelines for GeoQuery. | ||
Dataset ingest pipelines for [GeoQuery](https://www.aiddata.org/geoquery), a spatial data analysis tool from [AidData](https://www.aiddata.org/). | ||
|
||
## Overview | ||
## Documentation | ||
|
||
Each directory contains a full ingest pipeline for a dataset. It should contain: | ||
- A README detailing **all** the steps needed to reproduce from scratch. This may include a download script or instructions on how to manually download, instructions for running any processing scripts and/or step by step instructions for any manual processing, as well as any other relevant information about the dataset and processing (caveats, notes, suggested usage, etc.) | ||
- All scripts used to produce the data | ||
- An ingest JSON prepared in the standard format used by geo framework (see existing datasets for examples) | ||
Please see [our documentation site](https://aiddata.github.io/geo-datasets/) for detailed documentation. | ||
|
||
## Preparing Data on SciClone | ||
## Contributing | ||
|
||
All raw data should be initially downloaded into the `/sciclone/aiddata10/REU/pre_geo/raw` directory and processing should output to the `/sciclone/aiddata10/REU/pre_geo/data` directory. | ||
Thank you for your interest in contributing to geo-datasets! | ||
There are two main ways you can help out: | ||
|
||
After code review, testing, and quality assurance steps data will be moved from the `raw` and `data` directories within `/sciclone/aiddata10/REU/pre_geo` to their respective directories in `/sciclone/aiddata10/REU/geo` for official inclusion in GeoQuery. | ||
1. [File an issue](https://github.com/aiddata/geo-datasets/issues/new/choose) to request a new or updated dataset, or report a bug. | ||
2. Contribute your own changes by opening a pull request. If you are not familar with how this works, please [get in touch](mailto:[email protected]). | ||
|
||
These pipelines are designed to run on [William & Mary's HPC clusters](https://www.wm.edu/offices/it/services/researchcomputing/), and supporting other systems is out of scope for this project. | ||
|
||
## License | ||
|
||
This repository is released under the MIT license. Please see LICENSE.md for more information. | ||
This repository is released under the MIT license. Please see [LICENSE.md](LICENSE.md) for more information. |