Skip to content

Commit

Permalink
Adding styling guidelines in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
atteggiani committed Mar 27, 2024
1 parent 6e68d04 commit ff063dd
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 14 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/linkspector.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# dirs:
# - docs
files:
- docs/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md
excludedDirs:
- drafts
- docs/css
- docs/js
- docs/fontello
- docs/fontawesome*
- docs/assets
baseUrl: https://access-hive.org.au/development-website/
useGitIgnore: true
46 changes: 34 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,42 @@
# ACCESS-Hive
[![ACCESS-Hive Badge](docs/assets/badge.svg)](https://access-hive.org.au/)
[![ACCESS-Hive Badge](docs/assets/badge.svg)][website]
[![github-contributors](https://img.shields.io/github/contributors/ACCESS-Hive/access-hive.github.io?color=blue&style=plastic)][github-repo]
[![forum-users](https://img.shields.io/discourse/users?color=blue&label=forum&server=https%3A%2F%2Fforum.access-hive.org.au&style=plastic)][forum]
[![Link Check](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml/badge.svg)](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml)

Documentation hub for the Earth System models, ACCESS, and their community.

This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL:

This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL:<br>
https://access-hive.org.au/

# How to Contribute
If you wish to add documentation to the ACCESS-Hive website see the [contribution guide](https://access-hive.org.au/about/contribute/) for instructions.

# How to Contribute [Draft TEST]

- Pull the latest version of `development` branch locally by using the following commands:
## Styling guidelines for contribution
Please follow the guidelines below so as to make the Hive consistent among the pages contributed by different people.

- Always prefer HTML syntax to Markdown when possible;
- Titles/subtitles should NOT include: code lines/blocks, bold (titles are usually already bold), italic, links;
- Code lines/blocks need to be used for lines/blocks of code and terminal commands;
- Italic needs to be used when referring to specific proper nouns (for example *Gadi* or *Accessdev*);
- Bold can be used to highlight some words (please do not overuse it);
- Links should be coded using HTML syntax.<br>External links (links that go to a website other than https://access-hive.org.au) need to specify `target="_blank"` (see HTML cheatsheet below);
- To signal an important note within the text, consider using a "warning note" (see HTML cheatsheet below);
- Instructions for different versions (for example different operative systems or different model vesrions) can be rendered using tabs (see HTML cheatsheet below);


### HTML Cheatsheet for the Hive
|Style|HTML Syntax|Rendered example|
|---|---|---|
|**Bold**|\<b>bold\</b>|**bold**|
|**Italic**|\<i>italic\</i>|*italic*|
|**Code line**|\<code>this is a code line\</code>|`this is a code line`|
|**Code block**|\<pre>\<code>this is a code block\</code>\</pre>|<pre><code>this is a code block</code></pre>|
|**Link (internal)**|\<a href="https://access-hive.org.au">ACCESS-Hive link\</a>|<a href="https://access-hive.org.au">ACCESS-Hive link</a>|
|**Link (external)**|\<a href="https://www.google.com" target="_blank">Google link\</a>|<a href="https://www.google.com" target="_blank">Google link</a><span style="display: inline-block; color: #3894FF; margin-left: 1px; font-size: 8px; vertical-align: text-top; rotate: 90deg;">&#9099;</span>|
|**Warning note**|\<div class="note">this is a warning note\<div>|![warning note](docs/assets/assets_for_readme/warning_note.png)|
|**Tabs**|\<pre>\<code>this is a code block\</code>\</pre>||

<!-- - Pull the latest version of `development` branch locally by using the following commands:
> Fetch the remote branches from github:
Expand All @@ -34,7 +56,7 @@ If you wish to add documentation to the ACCESS-Hive website see the [contributio
`git push --set-upstream origin dev/jasmeen/legacy-release`
- Prefixing the branch name with `dev/jasmeen` might be used as an indicator that this needs to merged in the `development` branch of access-hive (staging branch deployed on https://access-hive.org.au/development_site/), and _**not**_ the main branch.
- Prefixing the branch name with `dev/jasmeen` might be used as an indicator that this needs to merged in the `development` branch of access-hive (staging branch deployed on https://access-hive.org.au/development-website/), and _**not**_ the main branch.
- Work locally on the branch `dev/jasmeen/legacy-release`, and push the commits using the commands:
Expand All @@ -54,13 +76,13 @@ If you wish to add documentation to the ACCESS-Hive website see the [contributio
![Screenshot 2023-06-02 at 2 05 13 pm](https://github.com/ACCESS-Hive/access-hive.github.io/assets/42607679/ec141fc9-ee00-4a84-ae5a-081761400765)
- When creating a pull request (PR) please also assign a reviewer to avoid delays. For technical content please assign an expert reviewer.
- When creating a pull request (PR) please also assign a reviewer to avoid delays. For technical content please assign an expert reviewer. -->

# License
The ACCESS-Hive site is covered by [the CC-BY 4.0 license][License].
The ACCESS-Hive site is covered by the [CC-BY 4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode).

However, the material linked to from ACCESS-Hive is covered by various licensing agreements. Our users should directly refer to the terms and conditions of any material they are using to understand their rights and responsibilities.

[License]: License.md
[website]: https://access-hive.org.au
[github-repo]: https://github.com/ACCESS-Hive/access-hive.github.io.git
[forum]: https://forum.access-hive.org.au
[forum]: https://forum.access-hive.org.au
2 changes: 1 addition & 1 deletion docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</div>
<div class="card-text-container bold">How to contribute</div>
</a>
<a href="license" class="vertical-card aspect-ratio1to1">
<a href="License" class="vertical-card aspect-ratio1to1">
<div class="card-image-container" style="container-type:size;">
<div class="icon-cc white-background" style="font-size: 85cqh; color: black; height: 100%; width: 100%; display: flex; justify-content: center; align-items: center; border-radius: 0.35rem;"></div>
</div>
Expand Down
Binary file added docs/assets/assets_for_readme/warning_note.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ COSIMA is the Consortium for Ocean-Sea Ice Modelling in Australia, which brings
The <i>COSIMA Cookbook</i> is developed and maintained by COSIMA. While ACCESS-NRI does not own the code, it actively supports the use of the <i>COSIMA Cookbook</i> and its collection of `cosima-recipes` on <i>Gadi</i>.
ACCESS-NRI provides access to the latest version of <i>COSIMA Cookbook</i> via the `hh5` `access-med` <a href="\model_evaluation/model_evaluation_getting_started/model_evaluation_getting_started">conda environment for Model Evaluation on Gadi</a>.

The <i>COSIMA Cookbook</i> framework focuses on the [ACCESS-OM2](../../models/configurations/access-om.md) suite of models being developed and run by members of <a href="http://cosima.org.au/" target="_blank">COSIMA</a>. Nevertheless, this framework is suited to analysing any MOM5/ MOM6 output as well as output from other models.
The <i>COSIMA Cookbook</i> framework focuses on the [ACCESS-OM2](/models/configurations/access-om) suite of models being developed and run by members of <a href="http://cosima.org.au/" target="_blank">COSIMA</a>. Nevertheless, this framework is suited to analysing any MOM5/ MOM6 output as well as output from other models.

## Getting Started

Expand Down
1 change: 1 addition & 0 deletions docs/models/run-a-model/run-access-cm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{% set model = "ACCESS-CM" %}
# Run {{ model }}

<div class="note">
<b>Important for <i>accessdev</i> users!</b>
<br>
Expand Down
35 changes: 35 additions & 0 deletions drafts/configurations/access-am.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# ACCESS-AM


<img src="../../../assets/model-config-logos/configurations-without-titles/access-am.png" alt="ACCESS AM model" class="white-background with-border with-padding"></img>

The ACCESS Atmosphere Model (ACCESS-AM) is a global model with atmosphere and land surface components. It is often used in Atmospheric Model Intercomparison Project (AMIP) experiments where it is driven by historically observed sea surface temperature and sea ice data.

ACCESS-NRI will release supported ACCESS-AM configurations. The first release, ACCESS-AM2, will be derived from the [CSIRO ACCESS-CM2 configuration](./access-cm.md#access-cm2) and will include [atmosphere] and [land] components.

## ACCESS-AM2

This is the model configuration used for the AMIP experiments contributed to the World Climate Research Programme’s Coupled Model Intercomparison Project Phase 6 (CMIP6). Note that the CMIP model naming is the same for both the AM and CM configurations, so the CMIP6 experiments are ACCESS-CM2 AMIP rather than ACCESS-AM2.

The component models are the same as ACCESS-CM2:

- Atmosphere model (UM vn10.6, GA7.1 science configuration): N96 resolution (1.875° x 1.25°, 85 levels). Physical model only – no carbon cycle.

- Land surface model (CABLE2.5)

[**Citation** [@Bi2020]][ACCESS-CM2-cite]

### Other configurations

Some experiments already run with other atmospheric model configurations are listed at:

- [CLEX CMS wiki][UMexperiments]

[atmosphere]: ../model_components/atmosphere.md
[land]: ../model_components/land.md
[UM-hive]: ../model_components/atmosphere.md#the-unified-model
[JULES-hive]: ../model_components/land.md#jules
[CABLE-hive]: ../model_components/land.md#cable
[UMstart]: http://climate-cms.wikis.unsw.edu.au/Unified_Model
[UMexperiments]: http://climate-cms.wikis.unsw.edu.au/UM_Experiments
[ACCESS-CM2-cite]: https://www.publish.csiro.au/es/ES19040

0 comments on commit ff063dd

Please sign in to comment.