Skip to content

Commit e31424e

Browse files
authored
Update README.md
1 parent ff65d96 commit e31424e

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Mission.Space Weather Extension Specification
22

33
- **Title:** Mission.Space Weather Extension
4-
- **Identifier:** <>
4+
- **Identifier:** <https://github.com/AstrodynamicLimited/mission-space-weather/tree/main/json-schema/schema.json>
55
- **Field Name Prefix:** ms_weather
66
- **Scope:** Item, Collection
77
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
88
- **Owner**: @ADRyanHorgan
99

10-
This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
11-
This is the place to add a short introduction.
10+
This document explains the Mission.Space Weather Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
11+
This is a work in progress extension, adding key field for Mission.Space's space weather data to the STAC specification.
12+
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.
13+
The assets are currently available as csv files, but this can be amended subject to feedback.
1214

1315
- Examples:
1416
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
@@ -26,17 +28,18 @@ The fields in the table below can be used in these parts of STAC documents:
2628
- [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
2729
- [ ] Links
2830

29-
| Field Name | Type | Description |
30-
| ------------------------------------| ------- | ------------------------------------------------------------------------------------- |
31-
| ms_weather:sensor_geometric_factor | number | **REQUIRED**. Geometric factor of one PL sensor on the ZOHAR-1 instrument. |
32-
| ms_weather:sensor_surface_area | number | (m^2) Surface Area of one PL sensor on the ZOHAR-1 instrument. |
33-
| ms_weather:sensor_average_thickness | number | (m) Average thickness of one PL sensor on the ZOHAR-1 instrument. |
34-
| ms_weather:sensor_count | number |**REQUIRED**. Number of one PL sensor on the ZOHAR-1 instrument. |
35-
| ms_weather:minimum_proton_energy | number |**REQUIRED**. (MeV) Minimum Proton Energy that is detected by the ZOHAR-1 instrument. |
36-
| ms_weather:minimum_electron_energy | number |**REQUIRED**. (MeV) Minimum Electron Energy that is detected by the ZOHAR-1 instrument.|
37-
| ms_weather:measurement_interval | number |**REQUIRED**. (s) Time between each measurement. |
31+
| Field Name | Type | Description |
32+
| ------------------------------------| ------- | -------------------------------------------------------------------------------------- |
33+
| ms_weather:sensor_geometric_factor | number | **REQUIRED**. Geometric factor of one PL sensor on the ZOHAR-1 instrument. |
34+
| ms_weather:sensor_surface_area | number | (m^2) Surface Area of one PL sensor on the ZOHAR-1 instrument. |
35+
| ms_weather:sensor_average_thickness | number | (m) Average thickness of one PL sensor on the ZOHAR-1 instrument. |
36+
| ms_weather:sensor_count | number | **REQUIRED**. Number of one PL sensor on the ZOHAR-1 instrument. |
37+
| ms_weather:minimum_proton_energy | number | **REQUIRED**. (MeV) Minimum Proton Energy that is detected by the ZOHAR-1 instrument. |
38+
| ms_weather:minimum_electron_energy | number | **REQUIRED**. (MeV) Minimum Electron Energy that is detected by the ZOHAR-1 instrument.|
39+
| ms_weather:measurement_interval | number | **REQUIRED**. (s) Time between each measurement. |
3840

3941
## Best Practices
42+
Units for each field should be included in the [units object](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#units) on both a collection and item.
4043

4144
## Contributing
4245

0 commit comments

Comments
 (0)