diff --git a/docs/about/policies.md b/docs/about/policies.md index 2c283e756..2cf372921 100644 --- a/docs/about/policies.md +++ b/docs/about/policies.md @@ -1,4 +1,4 @@ -#
Policies {{ supported }}
+#
Policies
- [Procedures and Practices][pandp]: Contains documents outlining how ACCESS-NRI will function. These documents describe what users can expect and justifications for the decisions against criteria that are based on the values of the organisation. diff --git a/docs/about/support.md b/docs/about/support.md deleted file mode 100644 index f1e434732..000000000 --- a/docs/about/support.md +++ /dev/null @@ -1,27 +0,0 @@ -#
Support
- -## Support levels - -The site uses a system of tags to identify who supports the linked documentation or software, and the level of support you can expect: - -`Supported by ACCESS-NRI` {{ supported }} - -: Documentation that is actively maintained and supported by ACCESS-NRI. This is documentation that was either created by ACCESS-NRI, or it is existing documentation for which ACCESS-NRI has taken over responsibility. - -`Recommended by ACCESS-NRI` {{ recommended }} - -: Documentation for third-party software that ACCESS-NRI recommends and facilitates the use of at [NCI][nci-web] as a service to the community. This means ACCESS-NRI supports the infrastructure required to run the software, but not necessarily the software itself. - -`Community contributed` {{ community }} - -: Documentation that is of use to the community, but is not explicitly endorsed or supported by ACCESS-NRI. - -## How to get help - -Each entry on ACCESS-Hive links to another web site. There should be information on how to get help on the linked site. If there are no obvious channels for help, or the help is not adequate consider asking for assistance from fellow members of your community on the [ACCESS-Hive forum][access-hive-forum]. - -In the case of ACCESS-NRI supported documentation and software, marked {{ supported }}, if there is no information on how to get help, or your query is not appropriate for the support channels provided, please either ask on the [ACCESS-Hive forum][access-hive-forum] or [contact ACCESS-NRI directly][contact]. - -[contact]: contact.md -[nci-web]: https://www.nci.org.au -[access-hive-forum]: https://forum.access-hive.org.au \ No newline at end of file diff --git a/docs/about/user_support.md b/docs/about/user_support.md new file mode 100644 index 000000000..6a83441e4 --- /dev/null +++ b/docs/about/user_support.md @@ -0,0 +1,11 @@ +#
User support
+ +## How to get help + +Each entry on ACCESS-Hive links to another web site. There should be information on how to get help on the linked site. If there are no obvious channels for help, or the help is not adequate consider asking for assistance from fellow members of your community on the [ACCESS-Hive forum][access-hive-forum]. + +In the case of ACCESS-NRI supported documentation and software, marked , if there is no information on how to get help, or your query is not appropriate for the support channels provided, please either ask on the [ACCESS-Hive forum][access-hive-forum] or [contact ACCESS-NRI directly][contact]. + +[contact]: contact.md +[nci-web]: https://www.nci.org.au +[access-hive-forum]: https://forum.access-hive.org.au \ No newline at end of file diff --git a/docs/community_resources/community_data_processing.md b/docs/community_resources/community_data_processing.md index 686c4a315..2f40edbfc 100644 --- a/docs/community_resources/community_data_processing.md +++ b/docs/community_resources/community_data_processing.md @@ -5,14 +5,14 @@ ## Tools -### Kerchunk {{ community }} +### 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 {{ community }} +### CMOR3 *Climate Model Output Rewriter Version 3* @@ -21,7 +21,7 @@ Kerchunk is a library that provides a unified way to represent a variety of chun 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 {{ community }} +### xMIP [**Documentation**][xmip-doc] | [**Tutorial on NCI**][xmip-tutorial] | @@ -29,7 +29,7 @@ CMOR is used to produce CF-compliant netCDF files. The structure of the files cr This package facilitates the cleaning, organization and interactive analysis of Model Intercomparison Projects (MIPs) within the Pangeo software stack. -### APP4 (The ACCESS Post Processor) {{ community }} +### APP4 (The ACCESS Post Processor) [**Documentation**][APP4-doc] | [**Sources**][APP4-source] @@ -37,25 +37,25 @@ This package facilitates the cleaning, organization and interactive analysis of 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 {{ community }} +### 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 {{ recommended }} +### Synda synda is a command line tool to search and download files from the Earth System Grid Federation (ESGF) archive. -### FluxnetLSM {{ community }} +### 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 {{ community }} +### Metpy https://unidata.github.io/MetPy/latest/examples/formats/index.html @@ -66,14 +66,14 @@ MetPy is a collection of tools in Python for reading, visualizing, and performin Format types are: GINI Water Vapor Imagery, NEXRAD Level 3 File, and NEXRAD Level 2 File. -### xskillscore {{ community }} +### 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 {{ community }} +## 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) diff --git a/docs/community_resources/community_med_recipes.md b/docs/community_resources/community_med_recipes.md index 70254085c..acbf87e48 100644 --- a/docs/community_resources/community_med_recipes.md +++ b/docs/community_resources/community_med_recipes.md @@ -2,7 +2,7 @@ -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) {{ supported }}. 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 {{ community }}: +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 : @@ -26,7 +26,7 @@ We are trying to ingest more and more model evaluation and diagnostics recipes i
- ESMValTool {{ recommended }}
(Earth System Model EValuation Tool) + ESMValTool
(Earth System Model EValuation Tool)
@@ -49,7 +49,7 @@ We are trying to ingest more and more model evaluation and diagnostics recipes i
- COSIMA Cookbook / Recipes {{ recommended }}
(Consortium for Ocean-Sea Ice Modelling in Australia) + COSIMA Cookbook / Recipes
(Consortium for Ocean-Sea Ice Modelling in Australia)
@@ -78,7 +78,7 @@ We are trying to ingest more and more model evaluation and diagnostics recipes i
- iLAMB {{ recommended }}
(international Land Model Benchmarking) + iLAMB
(international Land Model Benchmarking)
@@ -99,7 +99,7 @@ We are trying to ingest more and more model evaluation and diagnostics recipes i
- iOMB {{ recommended }}
(international Ocean Model Benchmarking) + iOMB
(international Ocean Model Benchmarking)
@@ -122,7 +122,7 @@ IOMB uses the same code base as the International Land Model Benchmarking (ILAMB
- METPlus {{ recommended }}
(Model Evaluation Tool Plus) + METPlus
(Model Evaluation Tool Plus)
@@ -136,7 +136,7 @@ IOMB uses the same code base as the International Land Model Benchmarking (ILAMB Paper + To learn the basics of Git and GitHub. It also includes ACCESS-NRI's recommendations to setup GitHub. - ![NCI Logo](../../assets/nci_logo_color.svg){align=right width=40%} diff --git a/docs/index.md b/docs/index.md index ba9540bff..260fcbc34 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,18 +40,6 @@ ## About {% include "call_contribute.md" %} -## Support - -There is a system of tags to identify who supports the linked documentation or software, and the level of support you can expect: - -- `Supported by ACCESS-NRI` {{ supported }} - -- `Recommended by ACCESS-NRI` {{ recommended }} - -- `Community contributed` {{ community }} - -See the [support page](about/support.md) for details about the support levels: what is supported, by who, and how to access help. - ## Contribute to ACCESS-Hive [^1]
diff --git a/docs/model_evaluation/model_evaluation_data_processing.md b/docs/model_evaluation/model_evaluation_data_processing.md index a9e9f72d1..f0b58a82f 100644 --- a/docs/model_evaluation/model_evaluation_data_processing.md +++ b/docs/model_evaluation/model_evaluation_data_processing.md @@ -4,4 +4,4 @@ On this page, we will provide you a list of currated data processing tools. -While we are still ramping up this service, please take a look at the gallery of community tools on [Community Resources -> Community Data Processing Tools](../community_resources/community_data_processing.md) {{ community }}. \ No newline at end of file +While we are still ramping up this service, please take a look at the gallery of community tools on [Community Resources -> Community Data Processing Tools](../community_resources/community_data_processing.md) . \ No newline at end of file diff --git a/docs/model_evaluation/model_evaluation_model_catalogs/index.md b/docs/model_evaluation/model_evaluation_model_catalogs/index.md index 3dbbae697..0a4234e18 100644 --- a/docs/model_evaluation/model_evaluation_model_catalogs/index.md +++ b/docs/model_evaluation/model_evaluation_model_catalogs/index.md @@ -22,47 +22,47 @@ The premise of this ACCESS-NRI intake Catalog is to provide a ("meta") catalog o {% include "call_contribute.md" %} -## [NCI datasets][NCI-geonetwork] {{ recommended }} +## [NCI datasets][NCI-geonetwork] NCI has an extensive catalog of datasets of interest to the weather and climate community. These datasets are directly available on the NCI supercomputer and the [Australian Research Environment][ARE-opus] -## [CLEX NCI Data Collection Intake Catalogue][Intake-CLEX] {{ recommended }} +## [CLEX NCI Data Collection Intake Catalogue][Intake-CLEX] This is an Intake catalogue maintained by the ARC Centre of Excellence for Climate Extremes [(CLEX)][CLEX-web]. Only datasets from the NCI Catalog are referenced. The catalogue is available in intake's default catalogue list in the CLEX Conda environment. Two notebooks are provided in the docs folder showing how to access the ERA5 and CIP6 datasets. -## [Australia Climate Data Guide Catalogue][ACDG-Catalog] {{ recommended }} +## [Australia Climate Data Guide Catalogue][ACDG-Catalog] *A one-stop catalogue to discover Climate Data in Australia* The ACDG portal is a metadata portal listing climate research resources available in Australia from multiple data repositories. This is a community based project managed by the ACDG Single Access working group. This is a group of Australian climate community self-nominated representatives. Anyone is welcome to join the group or to contribute independently to the metadata portal the group is developing. -## [Australian Ocean Data Network][AODN-Network] {{ recommended }} +## [Australian Ocean Data Network][AODN-Network] The Australian Ocean Data Network (AODN) is an interoperable online network of marine and climate data resources. IMOS and the 6 Australian Commonwealth agencies ([see AODN Partners](https://imos.org.au/facilities/aodn/aodn-data-management/aodn-partners)) form the core of the AODN. Increasingly, though, universities and State government offices are offering up data resources to the AODN, and delivery of data to the AODN is being written in to significant research programs e.g. [National Environmental Science Program Marine Biodiversity Hub](http://www.nespmarine.edu.au/) and the [Great Australian Bight research program](http://www.misa.net.au/GAB). -## [Intake-Ilamb Catalog][Intake-Ilamb] {{ supported }} +## [Intake-Ilamb Catalog][Intake-Ilamb] The Intake-Ilamb catalog provides an yaml-style intake catalog of the reference data used for ESM model benchmarking in the International Land Model Benchmarking [(ILAMB)][ILAMB-web] effort. -## [FLUXNET][FLUXNET-web] {{ community }} +## [FLUXNET][FLUXNET-web] FLUXNET is an international “network of networks,” tying together regional networks of earth system scientists. FLUXNET scientists use the eddy covariance technique to measure the cycling of carbon, water, and energy between the biosphere and atmosphere. Scientists use these data to better understand ecosystem functioning, and to detect trends in climate, greenhouse gases, and air pollution. -## [CEDA Archive][CEDA-Archive-Web] {{ community }} +## [CEDA Archive][CEDA-Archive-Web] The CEDA Archive forms part of NERC's Environmental Data Service (EDS) and is responsible for looking after data from atmospheric and earth observation research. They host over 18 Petabytes of data from climate models, satellites, aircraft, met observations, and other sources. -### [OZFlux][OZFlux-web] {{ community }} +### [OZFlux][OZFlux-web] OzFlux is an ecosystem research network set up to provide Australian, New Zealand and global ecosystem modelling communities with consistent observations of energy, carbon and water exchange between the atmosphere and key Australian and New Zealand ecosystems. -## [Australian Community Reference Climate Data Collection][AusRefClimData] {{ recommended }} +## [Australian Community Reference Climate Data Collection][AusRefClimData] -{{ community }} [Australian Community Reference Climate Data Collection @ NCI] + [Australian Community Reference Climate Data Collection @ NCI] This collection is a collaborative effort between the Australian Climate Service (ACS), ARC Centre of Excellence for Climate Extremes (CLEX) and the wider Australian climate research community to re-establish and maintain a reference dataset collection at NCI. diff --git a/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_add_models.md b/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_add_models.md index 8deac88f5..4d7967e47 100644 --- a/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_add_models.md +++ b/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_add_models.md @@ -2,4 +2,4 @@ You've just run a new experiment, now you want to create an intake-esm catalog for that experiment? -Look at this [Tutorial](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/how_tos/building_intake-esm_catalogs.ipynb) {{ supported }} to learn how to add your own models. \ No newline at end of file +Look at this [Tutorial](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/how_tos/building_intake-esm_catalogs.ipynb) to learn how to add your own models. \ No newline at end of file diff --git a/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_search_models.md b/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_search_models.md index d9d4986f1..b282c04ba 100644 --- a/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_search_models.md +++ b/docs/model_evaluation/model_evaluation_model_catalogs/model_evaluation_search_models.md @@ -1,12 +1,12 @@ # Search for a model in the ACCESS-NRI intake Catalog -To have the huge amount of data from different experiments on the NCI storage at the palm of your hand, we provide a ("meta") catalog for you to query via python as part of the `#!python intake` package with our curated catalog plugin `#!python intake.cat.access_nri` {{ supported }}. +To have the huge amount of data from different experiments on the NCI storage at the palm of your hand, we provide a ("meta") catalog for you to query via python as part of the `#!python intake` package with our curated catalog plugin `#!python intake.cat.access_nri` . -To use this catalog, you need access to NCI's Gadi. Check out our [Get Started with ACCESS at NCI](../model_evaluation_getting_started/index.md) {{ supported }} guide on how to get access. +To use this catalog, you need access to NCI's Gadi. Check out our [Get Started with ACCESS at NCI](../model_evaluation_getting_started/index.md) guide on how to get access. -Once logged in to Gadi, you will need to add the `#!python access-nri-catalog` to your `#!python conda` environments and start an [ARE JupyterLab Session](https://are.nci.org.au/pun/sys/dashboard). Check out our [ACCESS-NRI Intake Catalog](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/getting_started/index.rst) guide {{ supported }} for the specific setup (note that you can only read in data from specific experiments if they are loaded through the *Storage* keyword). +Once logged in to Gadi, you will need to add the `#!python access-nri-catalog` to your `#!python conda` environments and start an [ARE JupyterLab Session](https://are.nci.org.au/pun/sys/dashboard). Check out our [ACCESS-NRI Intake Catalog](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/getting_started/index.rst) guide for the specific setup (note that you can only read in data from specific experiments if they are loaded through the *Storage* keyword). -Once your JupyterLab session started, you can access the `#!python intake` catalog to load the data. Take a look at this [Tutorial](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/how_tos/example_usage.ipynb) {{ supported }}. +Once your JupyterLab session started, you can access the `#!python intake` catalog to load the data. Take a look at this [Tutorial](https://github.com/ACCESS-NRI/access-nri-intake-catalog/blob/main/docs/how_tos/example_usage.ipynb) . ``` py # Impport packages for searching/loading/plotting diff --git a/docs/model_evaluation/model_evaluation_recipe_gallery.md b/docs/model_evaluation/model_evaluation_recipe_gallery.md index cbcec9884..7e22df3b7 100644 --- a/docs/model_evaluation/model_evaluation_recipe_gallery.md +++ b/docs/model_evaluation/model_evaluation_recipe_gallery.md @@ -6,7 +6,7 @@ While we are still building this gallery, please have a look at the Community ME Here, we plan to provide you with an embedded link to our actively maintained Model Evaluation and Dianostics (MED) Recipe Gallery, hosted at [medportal.herokuapp.com](https://medportal.herokuapp.com/models/published). For now, we provide a placeholder image with link and pointers to useful Model Evaluation and Dianostics (MED) resources. -##
Link to our MED Recipe Gallery {{ supported }}
+##
Link to our MED Recipe Gallery
diff --git a/docs/models/configurations/access-am.md b/docs/models/configurations/access-am.md index 679117fbd..bd97ca48a 100644 --- a/docs/models/configurations/access-am.md +++ b/docs/models/configurations/access-am.md @@ -1,4 +1,4 @@ -#
ACCESS-AM {{ supported }}
+#
ACCESS-AM
diff --git a/docs/models/configurations/access-cm.md b/docs/models/configurations/access-cm.md index e985b3048..e18df5236 100644 --- a/docs/models/configurations/access-cm.md +++ b/docs/models/configurations/access-cm.md @@ -1,4 +1,4 @@ -#
ACCESS-CM {{ supported }}
+#
ACCESS-CM
ACCESS-CM2 (ACCESS Coupled Model 2) is a global fully-coupled climate model that includes the atmosphere, ocean and sea-ice components, and produces physical climate simulations. ACCESS-CM2 is one of the two models run by the Australian climate community for the @@ -28,7 +28,7 @@ ACCESS-CM2 (ACCESS Coupled Model 2) is a global fully-coupled climate model that ACCESS-NRI will release an ACCESS-CM model configuration. The first release of ACCESS-CM will be derived from the [CSIRO ACCESS-CM2 configuration](#access-cm2) and will include [atmosphere], [land], [ocean] and [sea ice] components. -##
[ACCESS-CM2] {{ recommended }}
+##
[ACCESS-CM2]
[**Citation** [@Bi2020-vj]][ACCESS-CM2-cite] | [**Tutorial**][ACCESS-CM2-tute] diff --git a/docs/models/configurations/access-esm.md b/docs/models/configurations/access-esm.md index 762cc1916..0df7c11a8 100644 --- a/docs/models/configurations/access-esm.md +++ b/docs/models/configurations/access-esm.md @@ -1,4 +1,4 @@ -#
ACCESS-ESM {{ supported }}
+#
ACCESS-ESM
@@ -7,7 +7,7 @@ ACCESS-ESM stands for ACCESS **E**arth **S**ystem **M**odel. Earth system model ACCESS-NRI will release an ACCESS-ESM model configuration. The first release of ACCESS-ESM will be derived from the [CSIRO ACCESS-ESM1.5 configuration](#access-esm15) and will include [atmosphere], [land] and [land biogeochemistry], [ocean] and [ocean biogeochemistry], and [sea ice] components. -##
[ACCESS-ESM1.5] {{ recommended }}
+##
[ACCESS-ESM1.5]
[**Citation** [@Ziehn2020-fq]][ACCESS-ESM1.5-cite] diff --git a/docs/models/configurations/access-om.md b/docs/models/configurations/access-om.md index 9fb1c4d33..38b0ded94 100644 --- a/docs/models/configurations/access-om.md +++ b/docs/models/configurations/access-om.md @@ -1,5 +1,5 @@ -#
ACCESS-OM {{ supported }}
+#
ACCESS-OM
@@ -8,7 +8,7 @@ The ACCESS **O**cean **M**odel, ACCESS-OM, is a global coupled ocean and sea ice ACCESS-NRI will release supported ACCESS-OM configurations. The first release will be derived from the COSIMA [ACCESS-OM2][COSIMA-models] suite and will include [ocean] and [sea ice] components. -##
[ACCESS-OM2][COSIMA-models] {{ recommended }}
+##
[ACCESS-OM2][COSIMA-models]
[**Citation** [@Kiss2020-gmd]][ACCESS-OM2-cite] | [**Documentation**][ACCESS-OM2-docs] diff --git a/docs/models/configurations/access-s.md b/docs/models/configurations/access-s.md index ff31c0733..c4590e53c 100644 --- a/docs/models/configurations/access-s.md +++ b/docs/models/configurations/access-s.md @@ -1,4 +1,4 @@ -#
[ACCESS-S][ACCESS-S] {{ community }}
+#
[ACCESS-S][ACCESS-S]
diff --git a/docs/models/model_components/aerosols_atmospheric_chemistry.md b/docs/models/model_components/aerosols_atmospheric_chemistry.md index d7066130f..8479d6b8e 100644 --- a/docs/models/model_components/aerosols_atmospheric_chemistry.md +++ b/docs/models/model_components/aerosols_atmospheric_chemistry.md @@ -6,7 +6,7 @@ -##
[UKCA][ukca-wiki] {{ supported }}
+##
[UKCA][ukca-wiki]
The [UK Chemistry-Aerosol model (UKCA)][ukca-wiki] is a community atmospheric chemistry-aerosol global model developed in the United Kingdom. It is suitable for a range of topics in climate and environmental change research. @@ -16,7 +16,7 @@ UKCA chemistry model is enabled in ACCESS-CM2-Chem. -##
[GLOMAP][glomap-wiki] {{ supported }}
+##
[GLOMAP][glomap-wiki]
UKCA contains an aerosol scheme [GLObal Model of Aerosol Processes (GLOMAP)][glomap-wiki] that can be used independently. The multi-component, multi-modal GLOMAP model allows simulation of aerosol number, size and concentrations of individual components such as sulphate,sea salt and different types of carbon. diff --git a/docs/models/model_components/atmosphere.md b/docs/models/model_components/atmosphere.md index 0cdb3bd87..3ccb7c25d 100644 --- a/docs/models/model_components/atmosphere.md +++ b/docs/models/model_components/atmosphere.md @@ -6,7 +6,7 @@ -##
The Unified Model (UM) {{ supported }}
+##
The Unified Model (UM)
[The Unified Model (UM)][um-web] is a numerical model of the atmosphere used for both weather and climate applications, developed by the [Met Office][metoffice-web] in the United Kingdom (UK). It includes solutions of the equations of atmospheric fluid dynamics with advanced parameterizations of subgrid-scale physical processes like convection, cloud formation and atmospheric radiation. diff --git a/docs/models/model_components/bgc_land.md b/docs/models/model_components/bgc_land.md index 3b0b96130..86ee66a21 100644 --- a/docs/models/model_components/bgc_land.md +++ b/docs/models/model_components/bgc_land.md @@ -7,14 +7,14 @@ -##
[CASA-CNP][casa-web] {{ supported }}
+##
[CASA-CNP][casa-web]
-CASA (Carnegie-Ames-Stanford Approach)-CNP (Carbon-Nitrogen-Phosphorous) is the land biogeochemistry model developed in CABLE. - -CASA-CNP models the dynamics of carbon pools and nitrogen and phosphorous limitations. It is directly coupled with the CABLE land surface model. +[CASA-CNP][casa-web], the Carnegie-Ames-Stanford Approach with Carbon-Nitrogen-Phosphorus, is the biogeochemical module implemented in the ACCESS land surface model [CABLE][cable-wiki]. It models the dynamics of carbon pools and the dependance of carbon uptake due to nitrogen and phosphorous limitations. + ### How is CASA-CNP used? -CASA-CNP is switched on for carbon-cycle to use in the ACCESS-ESM1.5 model. +In the ACCESS-ESM1.5 model, CASA-CNP is enabled within CABLE for the simulation of the carbon cycle. -[casa-web]: https://carbonwaterobservatory.csiro.au/casa.html \ No newline at end of file +[casa-web]: https://carbonwaterobservatory.csiro.au/casa.html +[cable-wiki]: https://trac.nci.org.au/trac/cable/wiki \ No newline at end of file diff --git a/docs/models/model_components/bgc_ocean.md b/docs/models/model_components/bgc_ocean.md index b5277feb9..638902b65 100644 --- a/docs/models/model_components/bgc_ocean.md +++ b/docs/models/model_components/bgc_ocean.md @@ -6,7 +6,7 @@ -##
WOMBAT {{ supported }}
+##
WOMBAT
WOMBAT is the ocean carbon model (World Ocean Model of Biogeochemistry And Trophic-dynamics), developed in Australia. It calculates the carbon fluxes of the ocean, by simulating the evolution of phosphate, oxygen, dissolved inorganic carbon, alkalinity and iron with one class of phytoplankton and zooplankton. WOMBAT is a Nutrient, Phytoplankton, Zooplankton and Detritus (NPZD) model, with one zooplankton and one phytoplankton class. diff --git a/docs/models/model_components/coupler.md b/docs/models/model_components/coupler.md index fa0ce2f9a..f36a6d52d 100644 --- a/docs/models/model_components/coupler.md +++ b/docs/models/model_components/coupler.md @@ -1,23 +1,26 @@ -#
Coupler {{ supported }}
+#
Coupler
-A coupler is a software used to perform simulations with different model components at the same time. The coupler enables the different model components to exchange information during the simulation. +A coupler is a software package that allows synchronised exchanges of coupling information between numerical codes representing different components of the climate system. -##
[OASIS3-MCT][OASIS3-MCT] {{ supported }}
+##
[OASIS3-MCT][OASIS3-MCT]
-OASIS3-MCT consists of the OASIS coupler interfaced with the Model Coupling Toolkit (MCT) from the Argonne National Laboratory. OASIS3-MCT is the coupler used for: +[OASIS3-MCT][OASIS3-MCT] is the version of the Ocean Atmosphere Sea Ice Soil (OASIS) coupler interfaced with the Model Coupling Toolkit (MCT) from the Argonne National Laboratory. OASIS3-MCT is the coupler used in the configurations: - ACCESS-ESM1.5 -- ACCESS-CM2 +- ACCESS-CM2 - ACCESS-OM2 -- ACCESS-S1 +- ACCESS-S -##
[NUOPC interoperability layer][NUOPC] {{ recommended }}
+##
[NUOPC interoperability layer][NUOPC]
-The NUOPC interoperability layer is distributed via the Earth System Modelling Framework (ESMF). It is a coupler developed by the National Unified Operational Prediction Capability (NUOPC), a consortium of Navy (USA), NOAA and Air Force (USA) modelers. +[NUOPC][NUOPC-int-layer] (National Unified Operational Prediction Capability) Interoperability Layer defines conventions and a set of generic components for building coupled models using the Earth System Modeling Framework (ESMF). + +ACCESS-OM3, a configuration currently under development, uses [NUOPC to couple its MOM6 and CICE6 model components][coupler-choice] as there are no respective OASIS coupling interfaces for these components. [OASIS3-MCT]: https://oasis.cerfacs.fr/en/ -[NUOPC]: https://earthsystemmodeling.org/nuopc/ \ No newline at end of file +[NUOPC-int-layer]: https://earthsystemmodeling.org/nuopc/ +[coupler-choice]: https://github.com/COSIMA/access-om3/discussions/7 \ No newline at end of file diff --git a/docs/models/model_components/land.md b/docs/models/model_components/land.md index d6937599c..9406427c7 100644 --- a/docs/models/model_components/land.md +++ b/docs/models/model_components/land.md @@ -6,7 +6,7 @@ -##
[CABLE][cable-wiki] {{ supported }}
+##
[CABLE][cable-wiki]
[Community Atmosphere Biosphere Land Exchange (CABLE)][cable-web] is a land surface model, used to calculate the fluxes of momentum, energy, water and carbon between the land surface and the atmosphere. It also models the main biogeochemical cycles of the land ecosystem when used in conjunction with [the CASA-CNP module][casa-cnp]. @@ -20,7 +20,7 @@ CABLE is an open source model developed by a community of Australian climate sci [um-web]: https://www.metoffice.gov.uk/research/approach/modelling-systems/unified-model -##
[JULES][jules-web] {{ supported }}
+##
[JULES][jules-web]
The [Joint UK Land Environment System (JULES)](jules-web) is a community land surface model that can be used both as a standalone model and as the land surface component in the UM model. By modelling different land surface processes (surface energy balance, hydrological cycle, carbon cycle, dynamic vegetation, etc.) and their interaction with each other, JULES provides a framework to assess the impact of modifying a particular process on the ecosystem as a whole, e.g., the impact of climate change on hydrology. diff --git a/docs/models/model_components/ocean.md b/docs/models/model_components/ocean.md index 2b5524b5c..292b9dd24 100644 --- a/docs/models/model_components/ocean.md +++ b/docs/models/model_components/ocean.md @@ -6,15 +6,15 @@ -##
[Modular Ocean Model (MOM)][mom-wiki] {{ supported }}
+##
[Modular Ocean Model (MOM)][mom-wiki]
The [Modular Ocean Model (MOM)][mom-wiki] is one of the ocean components of the ACCESS climate model system. Used to simulate ocean currents at both regional and global scales, MOM is an invaluable tool for studying the global ocean climate system, as well as capabilities for regional and coastal applications. -###
MOM5 {{ supported }}
+###
MOM5
[**Source Code**][mom5-github] MOM5 is used in supported climate ACCESS configurations. -###
MOM6 {{ recommended }}
+###
MOM6
[**Source Code**][mom6-github] | [**Tutorials**][mom6-tutes] diff --git a/docs/models/model_components/sea-ice.md b/docs/models/model_components/sea-ice.md index f68373569..c7f39993e 100644 --- a/docs/models/model_components/sea-ice.md +++ b/docs/models/model_components/sea-ice.md @@ -6,7 +6,7 @@ -##
CICE {{ supported }}
+##
CICE
CICE is a numerical model for simulating the growth, melting and movement of polar sea ice. This software package was developed by researchers at [Los Alamos National Laboratory team][lanl-web] and is currently managed by the [CICE Consortium][cice-web], an international group of institutions formed to maintain and develop CICE in the public domain. [CICE5][cice5-wiki] is the current version used in ACCESS model configurations. diff --git a/mkdocs.yml b/mkdocs.yml index 443f599c8..2f395423d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,7 +84,7 @@ nav: - Home: - index.md - Contact: about/contact.md - - Support: about/support.md + - User support: about/user_support.md - Contribute: - Contribute: contribute/index.md - Edit on Github: contribute/edit-on-github.md