Skip to content

Configuration documentation needs for a release #371

@ccarouge

Description

@ccarouge

As we are slowly working towards a release of ESM1.6, we need to agree on which parts of the ESM1.6 configuration documentation should be done before the release. For the moment, the documentation has a template structure that is mostly empty of content.

We currently have information in the Contributing section and a first version of the Home page.

There are no hard requirements for any config documentation with a release as we recognise each model has unique specificities. Here are a few thoughts to get the conversation going:

  • CMIP7 forcings: we do not want to replicate the official documentation on these but we need to provide enough information so that users know what it is, where is the official documentation and what processing has been applied for ACCESS. @penguian , you are probably the best placed to have some input here. I don't know if you have already written some of it somewhere.
  • other inputs: I don't know how many other inputs there are, but it would be good to give some documentation on these. @NortonAlex , it would be good if you could write some information on the vegetation distribution, both the process for the global distribution and the link to LUH3 data and the process for the Australian trees. If you are planning to provide the information in a paper, there is no need to duplicate and the configs documentation could just link to that paper.
  • grids: under the inputs sections, there is space to give some information about the grids used. The information in these sections will depend on the component (ocean, sea ice, land, atmosphere). Is this needed for the release? If so, we need some volunteers to enter some information.
  • model components: we have empty pages for each model component. I'm not sure what type of information (and how much) we want in there. Having inputs from others would be useful.
  • configurations and experiments: what information do we want to give about each configuration that isn't about the inputs and forcings? Any feedback here would be welcome.
  • diagnostics: we have a diagnostics section. What would people want to see in this section?
  • infrastructure: It is currently sub-divided in "Building", "Architecture", "Git practices". I have started a page on building the model. Inputs on other sections is welcome. Do we want to add any information about the optimisation or the performance of the model @manodeep ?

@NortonAlex @har917 @rml599gh @manodeep @anton-seaice @DaveBi @aidanheerdegen @chrisb13 @dougiesquire @MartinDix @Whyborn (feel free to mention other people I may have forgotten that would be useful for this discussion).

If you think of some information you'd like to see in the configs doc but can't see under which section it would fit, don't hesitate to share because the organisation of the doc is not fixed and others might have ideas where to add it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions