Skip to main content
Back to top
Ctrl
+
K
ROMS-Tools documentation
Search
Ctrl
+
K
Features
Methods
Installation
Datasets
Download Instructions
Dataset Read Guidelines
Examples
End-to-end workflow (laptop)
Creating a grid
Creating initial conditions
Creating boundary forcing
Creating surface forcing
Creating river forcing
Creating tidal forcing
Creating carbon dioxide removal forcing
Preparing nested simulations
Partitioning the input files
Joining ROMS output files
Reading ROMS Output
Visualizing ROMS Output
Regridding ROMS Output
Analyzing Carbon Dioxide Removal (CDR) Metrics
Using ROMS-Tools with Dask
Contributor Guide
Release notes
Scientific References
API Reference
Grid
roms_tools.Grid.copy_with_ds
roms_tools.Grid.from_yaml
roms_tools.Grid.grid_to_dict
roms_tools.Grid.plot
roms_tools.Grid.plot_vertical_coordinate
roms_tools.Grid.save
roms_tools.Grid.to_yaml
roms_tools.Grid.update_mask
roms_tools.Grid.update_topography
roms_tools.Grid.update_vertical_coordinate
TidalForcing
roms_tools.TidalForcing.from_yaml
roms_tools.TidalForcing.plot
roms_tools.TidalForcing.save
roms_tools.TidalForcing.to_yaml
SurfaceForcing
roms_tools.SurfaceForcing.from_yaml
roms_tools.SurfaceForcing.plot
roms_tools.SurfaceForcing.save
roms_tools.SurfaceForcing.to_yaml
InitialConditions
roms_tools.InitialConditions.from_yaml
roms_tools.InitialConditions.plot
roms_tools.InitialConditions.save
roms_tools.InitialConditions.to_yaml
BoundaryForcing
roms_tools.BoundaryForcing.from_yaml
roms_tools.BoundaryForcing.plot
roms_tools.BoundaryForcing.save
roms_tools.BoundaryForcing.to_yaml
RiverForcing
roms_tools.RiverForcing.from_yaml
roms_tools.RiverForcing.plot
roms_tools.RiverForcing.plot_locations
roms_tools.RiverForcing.save
roms_tools.RiverForcing.to_yaml
DaiRiverDataset
roms_tools.datasets.river_datasets.DaiRiverDataset.add_time_info
roms_tools.datasets.river_datasets.DaiRiverDataset.load_data
GloFASRiverDataset
roms_tools.datasets.river_datasets.GloFASRiverDataset.add_time_info
VolumeRelease
roms_tools.VolumeRelease.get_tracer_metadata
TracerPerturbation
roms_tools.TracerPerturbation.get_tracer_metadata
CDRForcing
roms_tools.CDRForcing.compute_total_cdr_source
roms_tools.CDRForcing.from_yaml
roms_tools.CDRForcing.model_post_init
roms_tools.CDRForcing.plot_distribution
roms_tools.CDRForcing.plot_locations
roms_tools.CDRForcing.plot_tracer_concentration
roms_tools.CDRForcing.plot_tracer_flux
roms_tools.CDRForcing.plot_volume_flux
roms_tools.CDRForcing.save
roms_tools.CDRForcing.to_yaml
ROMSOutput
roms_tools.ROMSOutput.cdr_metrics
roms_tools.ROMSOutput.create_movie
roms_tools.ROMSOutput.plot
roms_tools.ROMSOutput.regrid
roms_tools.ROMSOutput.plot
roms_tools.ROMSOutput.create_movie
roms_tools.ROMSOutput.regrid
roms_tools.ROMSOutput.cdr_metrics
Ensemble
roms_tools.Ensemble.plot
roms_tools.setup.nesting.align_grids
roms_tools.setup.nesting.make_nesting_info
roms_tools.tiling.partition.partition_netcdf
roms_tools.tiling.join.join_netcdf
roms_tools.plot.plot
roms_tools.datasets.lat_lon_datasets.get_glorys_bounds
roms_tools.setup.utils.compute_potential_density
roms_tools.setup.utils.compute_mld
.rst
.pdf
roms_tools.Grid.grid_to_dict
Contents
Grid.grid_to_dict()
roms_tools.Grid.grid_to_dict
#
Grid.
grid_to_dict
(
)
→
dict
#
Put all grid parameters into a dictionary.
Contents
Grid.grid_to_dict()