Skip to content

Commit

Permalink
fixed after merging with development
Browse files Browse the repository at this point in the history
  • Loading branch information
atteggiani committed Aug 7, 2023
2 parents 16fa4bc + 2fe8f89 commit 60c84a9
Show file tree
Hide file tree
Showing 36 changed files with 561 additions and 1,465 deletions.
Binary file modified docs/assets/model_evaluation/intake_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/terminal_animation_switch_active.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
261 changes: 166 additions & 95 deletions docs/community_resources/community_med/community_data_processing.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,168 @@
# Community Processing Data Processing Tools

<!-- {% include "call_contribute.md" %} -->


## Tools

### Kerchunk

[**Documentation**][kerchunk-doc] |
[**Sources**][kerchunk-source]

Kerchunk is a library that provides a unified way to represent a variety of chunked, compressed data formats (e.g. NetCDF/HDF5, GRIB2, TIFF, …), allowing efficient access to the data from traditional file systems or cloud object storage. It also provides a flexible way to create virtual datasets from multiple files.

### CMOR3

*Climate Model Output Rewriter Version 3*

[**Documentation**][cmor3-doc] |
[**Sources**][cmor3-source]

CMOR is used to produce CF-compliant netCDF files. The structure of the files created by CMOR and the metadata they contain fulfill the requirements of many of the climate community’s standard model experiments (which are referred to here as “MIPs” and include, for example, AMIP, PMIP, APE, and IPCC scenario runs).

### xMIP

[**Documentation**][xmip-doc] |
[**Tutorial on NCI**][xmip-tutorial] |
[**Sources**][xmip-source]

This package facilitates the cleaning, organization and interactive analysis of Model Intercomparison Projects (MIPs) within the Pangeo software stack.

### APP4 (The ACCESS Post Processor)

[**Documentation**][APP4-doc] |
[**Sources**][APP4-source]

The APP4 is a CMORisation tool designed to convert ACCESS model output to ESGF-compliant formats, primarily for publication to CMIP6. The code was originally built for CMIP5, and was further developed for CMIP6-era activities.
Uses CMOR3 and files created with the CMIP6 data request to generate CF-compliant files according to the CMIP6 data standards.

### ACCESS-Archiver

[**Documentation**][ACCESS-Archiver-doc] |
[**Sources**][ACCESS-Archiver-source]

The ACCESS Archiver is designed to archive model output from ACCESS simulations. It's focus is to copy ACCESS model output from its initial location to a secondary location (typically from `/scratch` to `/g/data`), while converting UM files to netCDF, compressing MOM/CICE files, and culling restart files to 10-yearly. Saves 50-80% of storage space due to conversion and compression.

### Synda

synda is a command line tool to search and download files from the Earth System Grid Federation (ESGF) archive.

### FluxnetLSM

[**Citation** [@Ukkola2017]][fluxnetlsm-cite] |
[**Sources**][fluxnetlsm-source]

R package for post-processing FLUXNET datasets for use in land surface modelling. Performs quality control and data conversion of FLUXNET data and collated site metadata. Supports FLUXNET2015, La Thuile, OzFlux and ICOS data releases.

### Metpy

https://unidata.github.io/MetPy/latest/examples/formats/index.html

[**Documentation**][metpy_docu] |
[**Sources**][metpy_docu-source]

MetPy is a collection of tools in Python for reading, visualizing, and performing calculations with weather data. MetPy supports Python >= 3.8 and is freely available under a permissive open source license.

Format types are: GINI Water Vapor Imagery, NEXRAD Level 3 File, and NEXRAD Level 2 File.

### xskillscore

[**Documentation**][xskillscore-doc] |
[**Sources**][xskillscore-source]

xskillscore is a Python library for computing a wide variety of skill metrics. Its typical application is to verify deterministic and probabilistic forecasts relative to observations.

## Analysis blogposts and tutorials

[Accessing NetCDF and GRIB file collections as cloud-native virtual datasets using Kerchunk, Peter March, Sep 2022](https://medium.com/pangeo/accessing-netcdf-and-grib-file-collections-as-cloud-native-virtual-datasets-using-kerchunk-625a2d0a9191)


[kerchunk-doc]: https://fsspec.github.io/kerchunk/
[kerchunk-source]: https://github.com/fsspec/kerchunk
[APP4-doc]: https://github.com/ACCESS-Hive/APP4
[APP4-source]: https://github.com/ACCESS-Hive/APP4
[ACCESS-Archiver-doc]: https://github.com/ACCESS-Hive/ACCESS-Archiver
[ACCESS-Archiver-source]: https://github.com/ACCESS-Hive/ACCESS-Archiver
[xskillscore-doc]: https://xskillscore.readthedocs.io/en/stable/
[xskillscore-source]: https://github.com/xarray-contrib/xskillscore
[fluxnetlsm-source]: https://github.com/aukkola/FluxnetLSM
[fluxnetlsm-cite]: https://gmd.copernicus.org/articles/10/3379/2017/
[metpy_docu]: https://unidata.github.io/MetPy/latest/examples/formats/index.html
[metpy_docu-source]: https://github.com/Unidata/MetPy
[cmor3-doc]: https://cmor.llnl.gov/
[cmor3-source]: https://github.com/PCMDI/cmor
[xmip-doc]: https://cmip6-preprocessing.readthedocs.io/en/latest/?badge=latest
[xmip-source]: https://github.com/jbusecke/xMIP
[xmip-tutorial]: https://github.com/coecms/xmip_nci
???+ danger "Support Level: NOT supported by ACCESS-NRI"
Here, we collate lists of useful tools for Model Evaluation and Diagnostics (MED). Contrary to the supported content of our [ACCESS-NRI Model Evaluation pages](../../model_evaluation/index.md), the information below is not supported by ACCESS-NRI unless stated otherwise.

Please let us know, if we are missing an important tool. See [How To Contribute](../../contribute/index.md) to get in touch.

<table>
<tr>
<td width="25%">
<div align='center' width="100%">
<h3>Dataset</h3>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
<h3>Description</h3>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://cmor.llnl.gov/" target="_blank">CMOR3<br>(Climate Model Output Rewriter Version 3)</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
CMOR is used to produce CF-compliant netCDF files. The structure of the files created by CMOR and the metadata they contain fulfill the requirements of many of the climate community’s standard model experiments (which are referred to here as “MIPs” and include, for example, AMIP, PMIP, APE, and IPCC scenario runs).
<br>
<a href="https://cmor.llnl.gov/" target="_blank">Documentation</a> |
<a href="https://github.com/PCMDI/cmor" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://github.com/ACCESS-Hive/APP4" target="_blank">APP4 (The ACCESS Post Processor)</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
The APP4 is a CMORisation tool designed to convert ACCESS model output to ESGF-compliant formats, primarily for publication to CMIP6. The code was originally built for CMIP5, and was further developed for CMIP6-era activities. It uses CMOR3 and files created with the CMIP6 data request to generate CF-compliant files according to the CMIP6 data standards.
<br>
<a href="https://github.com/ACCESS-Hive/APP4" target="_blank">Documentation</a> |
<a href="https://github.com/ACCESS-Hive/APP4" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://github.com/ACCESS-Hive/ACCESS-Archiver" target="_blank">ACCESS-Archiver</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
The ACCESS Archiver is designed to archive model output from ACCESS simulations. It's focus is to copy ACCESS model output from its initial location to a secondary location (typically from `/scratch` to `/g/data`), while converting UM files to netCDF, compressing MOM/CICE files, and culling restart files to 10-yearly. Saves 50-80% of storage space due to conversion and compression.
<br>
<a href="https://github.com/ACCESS-Hive/ACCESS-Archiver" target="_blank">Documentation</a> |
<a href="https://github.com/ACCESS-Hive/ACCESS-Archiver" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://fsspec.github.io/kerchunk/" target="_blank">Kerchunk</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
Kerchunk is a library that provides a unified way to represent a variety of chunked, compressed data formats (e.g. NetCDF/HDF5, GRIB2, TIFF, …), allowing efficient access to the data from traditional file systems or cloud object storage. It also provides a flexible way to create virtual datasets from multiple files.
Read this <a href="https://medium.com/pangeo/accessing-netcdf-and-grib-file-collections-as-cloud-native-virtual-datasets-using-kerchunk-625a2d0a9191" target="_blank">blogpost</a> on how to access NetCDF and GRIB file colletions with Kerchunk.
<br>
<a href="https://fsspec.github.io/kerchunk/" target="_blank">Documentation</a> |
<a href="https://github.com/fsspec/kerchunk" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://cmip6-preprocessing.readthedocs.io/en/latest/?badge=latest" target="_blank">xMIP</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
This package facilitates the cleaning, organization and interactive analysis of Model Intercomparison Projects (MIPs) within the Pangeo software stack.
<br>
<a href="https://cmip6-preprocessing.readthedocs.io/en/latest/?badge=latest" target="_blank">Documentation</a> |
<a href="https://github.com/jbusecke/xMIP" target="_blank">Source Code</a> |
<a href="https://github.com/coecms/xmip_nci" target="_blank">Tutorial</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://espri-mod.github.io/synda/" target="_blank">esgpull and synda</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
esgpull and synda are command line tools to search and download files from the Earth System Grid Federation (ESGF) archive. esgpull is a tool that simplifies usage of the ESGF Search API for data discovery, and manages procedures related to downloading and storing files from ESGF.
<br>
<a href="https://github.com/ESGF/esgf-download" target="_blank">Documentation</a> |
<a href="https://github.com/ESGF/esgf-download" target="_blank">Source Code (esgpull)</a> |
<a href="https://espri-mod.github.io/synda/" target="_blank">Source Code (synda)</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://github.com/aukkola/FluxnetLSM" target="_blank">FluxnetLSM</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
R package for post-processing FLUXNET datasets for use in land surface modelling. Performs quality control and data conversion of FLUXNET data and collated site metadata. Supports FLUXNET2015, La Thuile, OzFlux and ICOS data releases.
<br>
<a href="https://gmd.copernicus.org/articles/10/3379/2017/" target="_blank">Documentation</a> |
<a href="https://github.com/aukkola/FluxnetLSM" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://unidata.github.io/MetPy/latest/examples/formats/index.html" target="_blank">MetPy</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
MetPy is a collection of tools in Python for reading, visualizing, and performing calculations with weather data. Format types are GINI Water Vapor Imagery, NEXRAD Level 3 File, and NEXRAD Level 2 File.
<br>
<a href="https://unidata.github.io/MetPy/latest/examples/formats/index.html" target="_blank">Documentation</a> |
<a href="https://github.com/Unidata/MetPy" target="_blank">Source Code</a>
</div>
</td>
</tr>

<tr>
<td width="25%">
<div align='center' width="100%">
<a href="https://xskillscore.readthedocs.io/en/stable/" target="_blank">xskillscore</a>
</div>
</td>
<td width="75%">
<div align='center' width="100%" >
xskillscore is a Python library for computing a wide variety of skill metrics. Its typical application is to verify deterministic and probabilistic forecasts relative to observations.
<br>
<a href="https://xskillscore.readthedocs.io/en/stable/" target="_blank">Documentation</a> |
<a href="https://github.com/xarray-contrib/xskillscore" target="_blank">Source Code</a>
</div>
</td>
</tr>
</table>
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Community Model Evaluation and Diagnostics (MED) Recipe Gallery

<!-- {% include "call_contribute.md" %} -->
???+ danger "Support Level: NOT supported by ACCESS-NRI"
Here, we collate lists of useful resources for Model Evaluation and Diagnostics (MED). Contrary to the supported content of our [ACCESS-NRI Model Evaluation pages](../../model_evaluation/index.md), the information below is not supported by ACCESS-NRI unless stated otherwise.

We are trying to ingest more and more model evaluation and diagnostics recipes in your currated [recipe gallery on this website](../../model_evaluation/model_evaluation_recipe_gallery.md). While this is a continous effort, this site is intented for a list of model evaluation and diagnostics recipes that are not (yet) ingested but may be interesting for the community:

Expand Down Expand Up @@ -379,4 +380,4 @@ IOMB uses the same code base as the International Land Model Benchmarking (ILAMB
</tr>


<table/>
</table>
Loading

0 comments on commit 60c84a9

Please sign in to comment.