Skip to content

Commit

Permalink
Adding additional repo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
brian-knosp committed Aug 20, 2024
1 parent 56e8d77 commit 2422415
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Our code of conduct is maintained on our website, please see: [https://nasa-jpl.github.io/tos2ca-documentation/code_of_conduct](https://nasa-jpl.github.io/tos2ca-documentation/code_of_conduct)
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Our contributing guide is maintained on our website, please see: [https://nasa-jpl.github.io/tos2ca-documentation/contributing](https://nasa-jpl.github.io/tos2ca-documentation/contributing)
1 change: 1 addition & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Our governance model is maintained on our website, please see: [https://nasa-jpl.github.io/tos2ca-documentation/governance](https://nasa-jpl.github.io/tos2ca-documentation/governance)
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![Language](https://img.shields.io/badge/python-3.9-blue)](#)

The ``anomaly-detection`` library is part of the of the TOS2CA Project. For more information, visit the TOS2CA website at [https://nasa-jpl.github.io/tos2ca-documentation/](https://nasa-jpl.github.io/tos2ca-documentation/).

This python library is responsible for:
- Taking user input about an inequality, variables, temporal bounds, and geospatial bounds
- Retrieving subsetted data matching that user input
Expand Down Expand Up @@ -46,7 +48,7 @@ Running the library in an end-to-end fashion requires the following steps:
03. Run the curator, which will output a netCDF-4 file with the data for each anomaly at each time step. Note that incronguities may exist beween the grids and timesteps between the data used in PhDef and the requested curator data. See the metadata in the output curated data file for additional information on this.
04. Upload the curated data file and JSON hierarchy file to S3.
05. Run the curated file through the interpolater. This will get the curated data on the same temporal and spatial resolution as the original mask data. This way the user can compare them more easily. This will also generate statistics in the metadata of the interpolated file. The interpolated fill will also be stored in S3.
05. E-Mail the user that their job is complete and send them the locatin of the S3 bucket with their job directory.
06. Mark the job as ``'complete'`` in the database.
07. User can make plots of individual anomalies at spcific timestamps using the interpolated file.
06. E-Mail the user that their job is complete and send them the locatin of the S3 bucket with their job directory.
07. Mark the job as ``'complete'`` in the database.
08. User can make plots of individual anomalies at spcific timestamps using the interpolated file.
The user can continue on to visualization tools, download the data, or exit the system here.

0 comments on commit 2422415

Please sign in to comment.