Sample data

The package includes several sample data sets to show how to interact with the API. You do not need to get your data into the same format as these data, but doing so will likely make it simpler to use DeltaMetrics, and to get the most benefit from the tools included here.

The sample data are defined in deltametrics.sample_data.

The sample data cubes can be accessed as, for example:

>>> import deltametrics as dm
>>> golfcube = dm.sample_data.golf()

Note

Data is handled by pooch and will be downloaded and cached on local computer as needed.

Available information on the data cubes is enumerated in the following section.

Example data cubes

deltametrics.sample_data.golf()

Golf Delta dataset.

This is a synthetic delta dataset generated from the pyDeltaRCM numerical model. This model run was created to generate sample data. Model was run on 10/14/2021, at the University of Texas at Austin.

Run was computed with pyDeltaRCM v2.1.0. See log file for complete information on system and model configuration.

Data available at Zenodo, https://doi.org/10.5281/zenodo.4456143.

Version history:
  • v1.1: 10.5281/zenodo.5570962

  • v1.0: 10.5281/zenodo.4456144

(png, hires.png)

../../_images/index-11.png
deltametrics.sample_data.xslope()

xslope delta dataset.

The delta model runs in this dataset were executed in support of a demonstration and teaching clinic. The set of simualtions examines the effect of a basin with cross-stream slope on the progradation of a delta system.

Important

This sample data provides two datasets. Calling this function returns two DataCube.

Models were run on 02/21/2022, at the University of Texas at Austin.

Runs were computed with pyDeltaRCM v2.1.2. See log files for complete information on system and model configuration.

Data available at Zenodo, version 1.1: 10.5281/zenodo.6301362

Version history:
  • v1.0: 10.5281/zenodo.6226448

  • v1.1: 10.5281/zenodo.6301362

(png, hires.png)

../../_images/index-21.png
Returns:

  • xslope0 – First return, a DataCube with flat basin.

  • xslope1 – Second return, a DataCube with sloped basin in the cross-stream direction. Slope is 0.001 m/m, with elevation centered at channel inlet.

deltametrics.sample_data.aeolian()

An aeolian dune field dataset.

This is a synthetic delta dataset generated from the Swanson et al., 2017 “A Surface Model for Aeolian Dune Topography” numerical model. The data have been subsetted, only keeping the first 500 saved timesteps, and formatted into a netCDF file.

Swanson, T., Mohrig, D., Kocurek, G. et al. A Surface Model for Aeolian Dune Topography. Math Geosci 49, 635–655 (2017). https://doi.org/10.1007/s11004-016-9654-x

Dataset reference: https://doi.org/10.6084/m9.figshare.17118827.v1

Details:
  • default simualtion parameters were used.

  • only the first 500 timesteps of the simulation were recorded into the netcdf file.

  • the ordering for “easting” and “northing” coordinates in the netCDF file is opposite from the paper—that is the source region is along the second axis, i.e., dim1[source_regiom]==0. The display of this dataset is thus different from the original paper, but the data are the same.

  • simulation used the model code included as a supplement to the paper found here: https://static-content.springer.com/esm/art%3A10.1007%2Fs11004-016-9654-x/MediaObjects/11004_2016_9654_MOESM5_ESM.txt

  • simulation was executed on 12/02/2021 with Matlab R2021a on Ubuntu 20.04.

(png, hires.png)

../../_images/index-31.png
deltametrics.sample_data.landsat()

Landsat image dataset.

This is a set of satellite images from the Landsat 5 satellite, collected over the Krishna River delta, India. The dataset includes annual-composite scenes from four different years ([1995, 2000, 2005, 2010]) and includes data collected from four bands ([‘Red’, ‘Green’, ‘Blue’, ‘NIR’]).

(png, hires.png)

../../_images/index-41.png
deltametrics.sample_data.rcm8()

Rcm8 Delta dataset.

This is a synthetic delta dataset generated from the pyDeltaRCM numerical model. Unfortunately, we do not know the specific version of pyDeltaRCM the model run was executed with. Moreover, many new coupling features have been added to pyDeltaRCM and DeltaMetrics since this run. As a result, this dataset is slated to be deprecated at some point, in favor of the golf dataset.

Important

If you are learning to use DeltaMetrics or developing new codes or documentation, please use the golf delta dataset.

Warning

This cube may be removed in future releases.

(png, hires.png)

../../_images/index-51.png

Paths to data files

Note

The file path to each sample data cube can be accessed by a call to sample_data._get_xxxxxx_path() for the corresponding data set.

>>> dm.sample_data._get_golf_path()
'<cache-path>/deltametrics/golf.zip.unzip/pyDeltaRCM_output.nc'