Skip to content

Overview

Getting involved in ACCESS-AM3

There are several ways we welcome feedback and contributions on ACCESS-AM3 development. Contributions from people of all career stages and backgrounds are highly encouraged. Development is led by ACCESS-NRI, the Commonwealth Science and Industrial Research Organisation (CSIRO) and the ARC Centre of Excellence for Weather in the 21st Century (W21C). We follow an open development workflow where possible, building on the work of international modelling groups.

Interact with developers in person

If you would like to interact in person with the development team, there are regular Land Working Group meetings on the first and third Wednesday of every month (see this thread on the ACCESS-Hive Forum) and Atmosphere Working Group meetings are organised on an ad-hoc basis (see this thread on the ACCESS-Hive Forum). Everyone is welcome to suggest agenda items and participate (see the threads for the respective agendas). If you'd like to come, get in touch on ACCESS-Hive Forum either under the ACCESS-AM3 category.

We also manage most of our development on GitHub. We track ACCESS-AM3 work on a GitHub project board here. If you'd like to have your issue considered for ACCESS-AM3 development, please open an issue on the ACCESS-AM3 configurations repository.

Warning

This model uses components and science configurations from the UK Met Office (UKMO), and as such are license restricted. This means the associated repositories are required to be private. If you would like to be granted access to these repositories, please get in touch by replying to this ACCESS-Hive Forum topic.

Help us evaluate and improve applications of AM

[TODO] Update this section after it is clarified in the next Atmosphere WG meeting.

Report a bug or make a suggestion

Technical issues related to ACCESS-AM3 are best posted to github.com/ACCESS-NRI/access-am3-configs/issues. If you would like to discuss the issue first, feel free to post it on the ACCESS-HIVE forum.

ACCESS-AM3-configs-doc documentation contributions welcome 🙏

This documentation is a work in progress, and we welcome any contributions, including corrections and suggestions.

All contributions are welcome but we would particularly appreciate text suggestions (below). Contributions can be made in a few ways:

Quick contributions

Tip

This method has the advantage that it's very quick (<1 minute!). The caveat is that, unless you have write access to the access-am3-configs-doc repository, you will not be able to preview the changes rendered into a website or create whole new pages.

The simplest and fastest way to make a change to an existing page is to click the edit "pencil" on the top-right corner. This will go to the relevant GitHub markdown file and clicking the top-right pencil again on GitHub will allow you to edit the file. Once complete, click Commit changes.... There are then two possibilities, depending on whether you have write access to access-am3-configs-doc:

  1. No write access: this will prompt you to make a fork and then a pull request (less than 1 minute!).
  2. You have write access: please commit changes on a new branch and then use a pull request (this relates to the next option).

Larger contributions (online PR-previews)

Tip

This method allows you create whole new pages, and to preview the changes rendered into a website. It does not require you to install any software, but is only available for people with write access to access-am3-configs-doc.

Create a new branch, e.g. jblogs/doc-update, make doc changes (the documentation sources are in github.com/ACCESS-NRI/access-am3-configs-doc/tree/main/documentation), then open a related PR and a GitHub preview will be made automatically.

Larger contributions (mkdocs offline)

Tip

This method allows you create whole new pages and to preview the changes rendered into a website. It works whether or not you have write access to access-am3-configs-doc, but requires you to install mkdocs and takes the longest to set up.

Following these instructions but noting the documentation sources are in github.com/ACCESS-NRI/access-am3-configs-doc/tree/main/documentation. You'll need to fork and clone github.com/ACCESS-NRI/access-am3-configs-doc if you want to write your own content (mkdocs serve should be invoked from within the documentation directory).

Contribute a configuration

Information on how to contribute a configuration and what is expected of an ACCESS-NRI supported configuration.