Polaris

User's guide

  • Quick Start for Users
  • Tasks
  • Config Files
  • Suites
  • Mesh component
  • E3SM Initial Condition Component
  • Ocean component
  • Sea ice component
  • Machines

Developer's guide

  • Quick Start for Developers
  • Overview
  • Command-line interface
  • Organization of Tasks
  • E3SM initial condition (e3sm/init) component
  • Mesh component
  • Ocean component
  • Sea ice component
  • Framework
  • Machines
  • Benchmarking a branch against a baseline
  • Troubleshooting
  • Documentation
  • Building the Documentation
  • Previewing the Documentation
  • How Conda and Spack Work Together in Polaris
  • Updating Deployment Dependencies
  • Updating Shared Spack Environments
  • API reference
    • Components
    • polaris framework
      • Command-line interface
      • Base Classes
      • analysis
        • analysis.manifest
        • analysis.publish
        • analysis.thumbnail
        • analysis.site
      • config
      • io
      • job
      • logging
      • constants
      • mesh
      • Spherical Base Meshes
      • model_step
      • build
      • mpas
      • parallel
      • namelist
      • provenance
      • remap
      • resolution
      • streams
      • validate
      • viz
      • yaml
  • Design Documents

Tutorials

  • Developer Tutorial: Adding a New Category of Tasks

Glossary

  • Glossary
Polaris
  • API reference
  • polaris.analysis.site.gallery_filename
  • View page source

polaris.analysis.site.gallery_filename

polaris.analysis.site.gallery_filename(group, gallery, key=None)[source]

Get the name of the page holding one gallery

As with a published product, the name is the facets in a fixed order, so that two date ranges of the same gallery coexist.

Parameters:
  • group (str) – The product group the gallery belongs to

  • gallery (str) – The gallery within that group

  • key (str, optional) – The zero-padded range of years the gallery covers, if it covers one

Returns:

filename (str) – The name of the page within the galleries directory

Previous Next

© Copyright 2026, Energy Exascale Earth System Model Project.

Built with Sphinx using a theme provided by Read the Docs.