ARCHER2: n01 Oceans and Shelf Seas Consortium supplementry documentation

ARCHER2 is the next generation UK National Supercomputing Service. You can find more information on the service and the research it supports on the ARCHER2 website.

This repository contains additional documentation for the NERC, n01 Oceans and Shelf Seas consortium and is linked to a rendered version currently hosted on Github:n01-pages. This material includes a section on using NEMO on ARCHER2 which is duplicated in the official ARCHER2 documention prepared by EPCC, The University of Edinburgh. The rest of the material, here, is supplementry and based entirely on the personal experiences of members of the consortium. It is intended to provide guides and tips rather than rigid methodologies. As such it is likely to evolve more rapidly than the official documentation which should always be consulted first for information on wider aspects of the service.

How to contribute

We welcome contributions that improve the documentation from the n01 consortium. Contributions can take the form of improved or additional content and/or Issues that identify problems or opportunities for improvement.

To contribute content to this documentation, first you have to fork it on GitHub and clone it to your machine, see Fork a Repo for the GitHub documentation on this process.

Once you have the git repository locally on your computer, you will need to install Material for mkdocs to be able to build the documentation. This can be done using a local installation or using a Docker container.

Once you have made your changes and updated your Fork on GitHub you will need to Open a Pull Request.

Building the documentation on a local machine

Once Material for mkdocs is installed, you can preview the site locally using the instructions in the Material for mkdocs documentation.

Making changes and style guide

The documentation consists of a series of Markdown files which have the .md extension. These files are then automatically converted to HTMl and combined into the web version of the documentation by mkdocs. It is important that when editing the files the syntax of the Markdown files is followed. If there are any errors in your changes the build will fail and the documentation will not update, you can test your build locally by running mkdocs serve. The easiest way to learn what files should look like is to read the Markdown files already in the repository.

For a guide on the rst file format see this document.