Integration with third party apps: Develop the documentation of JSON format

[amyburness]

Develop the documentation of JSON format used for data transfer to PRAIS, including the JSON schema used to transfer results from Trends.Earth to PRAIS. Additionally, the documentation should enable other platforms to output data for ingestion into PRAIS without referring to the Trends.Earth codebase. Additionally, make any recommendations for simplification of the format or other improvements that could improve usability and reliability during data transfer.

[amyburness]

• Documentation of JSON format used to transfer data between Trends.Earth and PRAIS.

[amyburness]

A few key improvements that could be made to the JSON from my (@azvoleff ) perspective are:

Drought

• Shift geojson for AOI outside of summary json and into a separate geojson linked via a STAC
• Record metadata on the climate dataset (precpitation and possible evapotranspiration) and index (SPI or SPEI) used, as well as the timescale used for the calculation of the index

Land degradation

• Shift geojson for AOI outside of summary json and into a separate geojson linked via a STAC
• Shift geojson for false positive / negatives outside of summary json and into a separate geojson linked via a STAC
• Need to handle multiple time periods for reporting. Right now the JSON is setup to handle online one baseline period and one reporting period. Suggest revising the dictionary keys used under ["results"]["data"]["report"]["land_condition"]
• Consolidate mentions of the land cover legend so that it is only listed once per sub-indicator (land cover, SOC, and productivity). But retain ability to vary land cover legend by sub-indicator
• Support arbitrary period names for the periods listed under ["results"]["data"]["report"]["land_condition"] (as these will be assignable within Trends.Earth for user convenience / to aid in internationalization, etc.)
• Remove tables that are no longer needed due to revisions in PRAIS (need to connect with @Vlad Posea and @Brian O'Connor on this). For example SOC crosstabs that have been dropped from PRAIS
• Need to support some kind of metadata on sub-national analyses? (question for discussion with @Brian O'Connor)

Across both drought/land deg JSONs

• Need for further sanity checks w/in Trends.Earth to ensure values are consistent within JSON and across drought/land degradation JSONs prior to submission to UNCCD (ensuring class areas are consistent across years and with AOI, that values are valid, etc.)

[amyburness]

there are multiple reporting periods-> these need keys
where the legend is identical we need to remove duplication.
we need the final tables from PRAIS
the output metadata needs to include the metadata of the users options chosen in the analysis in addition to the dataset chosen.

[amyburness]

See JSON review meeting with UNCCD here: https://drive.google.com/file/d/1gkyCqsT-Nooa2GQLblQgW5kDooh2RvKT/view?usp=drive_link

[amyburness]

See the tables to remove here: https://docs.google.com/spreadsheets/d/1Ai_V4Vk7dHrasz_18EA7PBt2kQQOcVmEW-LuF_OupHQ/edit?usp=sharing

[amyburness]

Task list:

• Shift geojson for AOI outside of summary json and into a separate geojson linked via a STAC for both drought and Land degradation.
• Shift geojson for false positive / negatives outside of summary json and into a separate geojson linked via a STAC for Land degradation.