Policies

The E3SM project has the following policies on code, data, simulations, early access to data etc:

• All E3SM-developed software is open software development
• E3SM code is open software development (https://github.com/E3SM-Project/ )
• E3SM reserves the right to first publication from its data and new developments, hence
• Data is made available after the first overview journal publication is submitted
• Data can be downloaded through: (https://e3sm.org/data/ )
  • All Data: ESGF E3SM project space:  in native format, on native grid and regridded to lon-lat,
    • Also accessible through Globus (https://esgf-node.llnl.gov/projects/e3sm/ )
  • Subset: ESGF CMIP6  (subset of variables in CMIP6 format)
  • All Data archive: NERSC HPSS (world readable, native format)
• Simulation description, compsets, documentation and data is available after the first overview journal publication is submitted
• New features may be turned off in code, but are protected with the same policy of making it available after the journal publication on this development is submitted
• Only production, main simulations compsets are supported
• The only supported E3SM versions are:
  • maint-1.0, v1.0.0, doi: 10.11578/E3SM/dc.20180418.36, (Water Cycle Simulation Campaign)
  • maint-1.1, v1.1.1, doi: 10.11578/E3SM/dc.20200825.12, (BGC Simulation Campaign)
  • maint-1.2, v1.2.1, doi: 10.11578/E3SM/dc.20210309.1 (Cryosphere Simulation Campaign)
  • maint-2.0, v2.0.2, doi: 10.11578/E3SM/dc.20221118.3, (Water Cycle Simulation Campaign)
  • maint-2.1, v2.1.0, doi: 10.11578/E3SM/dc.20230110.5 (Water Cycle Simulation Campaign)
• Supported machines: NERSC, Compy (internal Anvil)

We ask that you respect E3SM right to first publication on new development and wait with your publication until E3SM has a chance to submit a paper on its new development

This applies when:

• Using a new code version that does not have an overview paper
• Using a new feature that is part of the code (for example a feature that is turned off in code) that was not part of any paper on this development
• Running the latest model configuration/compset
• Analyzing the latest data not yet published

We recommend that you submit a collaboration request (see below) when working with new development and coordinate with the E3SM Point of Contact (POC)

The ecosystem projects (the project funded by DOE BER to work on some aspects for E3SM)  or other projects that are planning on developing a piece of code for E3SM should:

•  Coordinate early through the E3SM POC (Point Of Contact) to understand
  • E3SM current and future code plans
  • E3SM interest and needs
• Complete Code Review Process: Design Document, Verification, Validation, Performance
  • E3SM’s new feature requirement
  • Code Review Process Implementation
• Adhere to coding standards
• Pay attention to performance
• Plan a lot of time for integration with E3SM
• Make sure there is a developer available to work closely with E3SM to resolve any issues when coupling to the full code stack and testing

Due to project’s limited resources – the E3SM cannot guarantee that it will incorporate the code

If a project would like to gain an early access to the data, simulation or other info, the External Projects should submit a collaboration request specifying

• What data/simulation/early access information/ you need
• What research you are planning to do
• Specify an E3SM POC
• Agree to collaborate and include the E3SM POC in your publication

Simply fill in the doc at  Collaboration Request

You can find more details on the E3SM communication and Support Policies for the E3SM Ecosystem projects from a recent presentation at the 2020 ESMD/E3SM Meeting.