Mission.Space Weather Extension Specification

• Title: Mission.Space Weather Extension
• Identifier: https://github.com/AstrodynamicLimited/mission-space-weather/tree/main/json-schema/schema.json
• Field Name Prefix: ms_weather
• Scope: Item, Collection
• Extension Maturity Classification: Proposal
• Owner: @ADRyanHorgan

This document explains the Mission.Space Weather Extension to the SpatioTemporal Asset Catalog (STAC) specification. This is a work in progress extension, adding key field for Mission.Space's space weather data to the STAC specification. Our primary goal with this extension has been to ensure that Mission.Space's data is compatible with Data Sphere (Astro Dynamic's Earth Observation marketplace) which uses STAC as it's metadata format. The data made available on STAC is open sample data from Mission.Space, showing high energy particle activity measured by the their Zohar-1 instrument during minor and major geomagnetic storms. The assets are currently available as csv files, but this can be amended subject to feedback.

• Examples:
  • Item example: Shows the basic usage of the extension in a STAC Item
  • Collection example: Shows the basic usage of the extension in a STAC Collection
• JSON Schema
• Changelog

Fields

The fields in the table below can be used in these parts of STAC documents:

• Catalogs
• Collections
• Item Properties (incl. Summaries in Collections)
• Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
• Links

Field Name	Type	Description
ms_weather:sensor_geometric_factor	number	REQUIRED. Geometric factor of one PL sensor on the ZOHAR-1 instrument.
ms_weather:sensor_surface_area	number	(m^2) Surface Area of one PL sensor on the ZOHAR-1 instrument.
ms_weather:sensor_average_thickness	number	(m) Average thickness of one PL sensor on the ZOHAR-1 instrument.
ms_weather:sensor_count	number	REQUIRED. Number of one PL sensor on the ZOHAR-1 instrument.
ms_weather:minimum_proton_energy	number	REQUIRED. (MeV) Minimum Proton Energy that is detected by the ZOHAR-1 instrument.
ms_weather:minimum_electron_energy	number	REQUIRED. (MeV) Minimum Electron Energy that is detected by the ZOHAR-1 instrument.
ms_weather:measurement_interval	number	(s) Time between each measurement.

Best Practices

Units for each field should be included in the units object on both a collection and item.

Contributing

All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions for running tests are copied here for convenience.

Running tests

The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. To run tests locally, you'll need npm, which is a standard part of any node.js installation.

First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:

npm install

Then to check markdown formatting and test the examples against the JSON schema, you can run:

npm test

This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.

If the tests reveal formatting problems with the examples, you can fix them with:

npm run format-examples