Skip to content

Update prerequisites #325

@ehogan

Description

@ehogan

Additional review comments from #292:

For doc/source/user_guide/prerequisites_metoffice.rst

  • L1-2: Comments in .rst files use .., the Coding requirements provides more information.
  • L4: Use "Prerequisites for running CMEW at the Met Office" for the title.
  • L10: When using a glossary term like |CMEW|, do not define the term in the text; the term is defined in the glossary, so that there is a single source of truth for the definition.
  • To simplify the prerequisites, would it be possible to consolidate the text into a table, please? Perhaps something like:

    Multiple tools are required to run |CMEW|.
    If you have a standard Linux account at the Met Office,
    these tools will already be installed,
    and the commands in the table below should work for you.

    Tool Command line command Available by default? Installation check
    Git git Yes which git, git --version
    Rose rose Yes which rose, rose --version
    Cylc cylc Yes which cylc, cylc --version
    CDDS cdds_convert No, run source ~cdds/bin/setup_env_for_cdds 3.2.0 which cdds_convert, cdds_convert --help
    MOOSE moo Yes which moo
    ESMValTool esmvaltool No, run module load scitools/community/esmvaltool/2.12.0 which esmvaltool, esmvaltool --version

    In addition, accounts must be correctly configured for the following tools:

    Tool Access check Request account
    GitHub https://github.com/login https://github.com/signup
    MOOSE moo --help ServiceNow
  • Git, GitHub and MOOSE should be added as glossary terms (I mentioned adding acronyms to the glossary in my review, but I feel these terms would also be useful to add). This could be added to a new issue, if preferred. Note that Rose, Cylc and ESMValTool are already in the glossary, so should have pipes around them.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions