gfdlvitals Logo

Getting Started

  • Overview
  • Installation
  • Installing in a virutal environment
  • Testing the installation

User Guide

  • Generating scalar diagnostics for a model experiment
  • Working with SQLite files
  • Using the VitalsDataFrame Class in Jupyter
  • Converting SQLite files to NetCDF
  • Plotting results from SQLite files

Help & reference

  • API Documentation
    • gfdlvitals package
      • VitalsDataFrame
      • open_db()
      • plot_timeseries()
      • Subpackages
        • gfdlvitals.averagers package
        • gfdlvitals.diags package
        • gfdlvitals.models package
        • gfdlvitals.util package
      • Submodules
    • gfdlvitals.averagers package
    • gfdlvitals.averagers.cubesphere module
    • gfdlvitals.averagers.ice module
    • gfdlvitals.averagers.land_lm3 module
    • gfdlvitals.averagers.land_lm4 module
    • gfdlvitals.averagers.latlon module
    • gfdlvitals.averagers.tripolar module
    • gfdlvitals.cli module
    • gfdlvitals.cli_db2nc module
    • gfdlvitals.cli_plotdb module
    • gfdlvitals.diags package
    • gfdlvitals.diags.amoc module
    • gfdlvitals.diags.fms module
    • gfdlvitals.diags.m6toolbox module
    • gfdlvitals.extensions module
    • gfdlvitals.models package
    • gfdlvitals.models.CM4 module
    • gfdlvitals.models.ESM2 module
    • gfdlvitals.plot module
    • gfdlvitals.sample module
    • gfdlvitals.util package
      • Submodules
        • gfdlvitals.util.average module
        • gfdlvitals.util.extract_ocean_scalar module
        • gfdlvitals.util.git module
        • gfdlvitals.util.gmeantools module
        • gfdlvitals.util.merge module
        • gfdlvitals.util.netcdf module
        • gfdlvitals.util.xrtools module
    • gfdlvitals.util.average module
    • gfdlvitals.util.extract_ocean_scalar module
    • gfdlvitals.util.git module
    • gfdlvitals.util.gmeantools module
    • gfdlvitals.util.merge module
    • gfdlvitals.util.netcdf module
    • gfdlvitals.util.xrtools module
gfdlvitals
  • API Documentation
  • gfdlvitals package
  • gfdlvitals.util package
  • View page source

gfdlvitals.util package

Generic utilities module

Submodules

  • gfdlvitals.util.average module
    • RichVariable
    • generic_cubesphere_driver()
    • process_var()
  • gfdlvitals.util.extract_ocean_scalar module
    • mom6()
  • gfdlvitals.util.git module
    • is_clean()
    • retrieve_commit()
  • gfdlvitals.util.gmeantools module
    • area_mean()
    • cube_sphere_aggregate()
    • extract_metadata()
    • get_web_vars_dict()
    • legacy_area_mean()
    • mask_latitude_bands()
    • parse_cell_measures()
    • write_metadata()
    • write_sqlite_data()
  • gfdlvitals.util.merge module
    • merge()
  • gfdlvitals.util.netcdf module
    • extract_from_tar()
    • in_mem_nc()
    • in_mem_xr()
    • tar_member_exists()
  • gfdlvitals.util.xrtools module
    • xr_mask_by_latitude()
    • xr_to_db()
    • xr_weighted_avg()
Previous Next

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