Skip to content

Commit

Permalink
docs: Use full links in readme (#4)
Browse files Browse the repository at this point in the history
Will make the links work from the PyPi project page.
  • Loading branch information
simentha committed Oct 20, 2023
1 parent 8f4702b commit f05cdd0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ Atmos is a project to streamline discoverability and data access for weather dat

## Data Validation

In order to ingest measurement or hindcast data into the Atmos Data Store, every source file needs to pass validation. Validation makes sure that the file is compliant with the data conventions specified in [Conventions](docs/conventions.md#11-time). The standard file formats for source files are NetCDF files for hindcasts and ASCII or NetCDF for measurements.
In order to ingest measurement or hindcast data into the Atmos Data Store, every source file needs to pass validation. Validation makes sure that the file is compliant with the data conventions specified in [Conventions](https://github.com/equinor/atmos-validation/blob/main/docs/conventions.md). The standard file formats for source files are NetCDF files for hindcasts and ASCII or NetCDF for measurements.

Measurements by definition contains data for a single geographical location, where as hindcasts are bigger models containing time series for a multitude of locations in (possibly rotated) grids. Measurement files are therefore expected to contain all its data in a single file. A hindcast is comprised of a set of NetCDF files - all with the same coordinates, attributes and variables - where a single file contains data for a unique time period. Depending on the size of the files, the time separation should be either monthly or yearly. A rule-of-thumb is that if file size grows more than 4 GB it should be split into smaller files. See [docs](docs/conventions.md#11-time) or [example](examples/hindcast_example/) for how to name hindcast files.
Measurements by definition contains data for a single geographical location, where as hindcasts are bigger models containing time series for a multitude of locations in (possibly rotated) grids. Measurement files are therefore expected to contain all its data in a single file. A hindcast is comprised of a set of NetCDF files - all with the same coordinates, attributes and variables - where a single file contains data for a unique time period. Depending on the size of the files, the time separation should be either monthly or yearly. A rule-of-thumb is that if file size grows more than 4 GB it should be split into smaller files. See [docs](https://github.com/equinor/atmos-validation/blob/main/docs/conventions.md#11-time) or [example](https://github.com/equinor/atmos-validation/tree/main/examples/hindcast_example) for how to name hindcast files.

To run validation on NetCDF and ASCII source files, we have built the atmos_validation CLI/library. The documentation will describe these checks and the standard format, and how to run validation using the CLI tool.

## Documentation

- [Conventions](docs/conventions.md)
- [Running CLI](docs/run.md)
- [Conventions](https://github.com/equinor/atmos-validation/blob/main/docs/conventions.md)
- [Running CLI](https://github.com/equinor/atmos-validation/blob/main/docs/run.md)

## Examples

- [Hindcast netcdfs format example](examples/hindcast_example/)
- [Measurement netcdf format example](examples/example_netcdf_measurement.nc)
- [Measurement ascii format example](examples/example_ascii_measurement.dat)
- [Hindcast netcdfs format example](https://github.com/equinor/atmos-validation/tree/main/examples/hindcast_example)
- [Measurement netcdf format example](https://github.com/equinor/atmos-validation/blob/main/examples/example_netcdf_measurement.nc)
- [Measurement ascii format example](https://github.com/equinor/atmos-validation/blob/main/examples/example_ascii_measurement.dat)

## Contributing

Expand Down

0 comments on commit f05cdd0

Please sign in to comment.