pyremap.descriptor.PointCollectionDescriptor

class pyremap.descriptor.PointCollectionDescriptor(lats, lons, collectionName, units='degrees', outDimension='nPoints')[source]

A class for describing a collection of points

Xylar Asay-Davis

04/19/2017

__init__(lats, lons, collectionName, units='degrees', outDimension='nPoints')[source]

Constructor stores

Parameters

  • lats (1D numpy arrays) – The latitude and longitude of each point

  • lons (1D numpy arrays) – The latitude and longitude of each point

  • collectionName (str) – A unique name for the collection of transects, used in the names of files containing data mapped to these points.

  • units ({'degrees', 'radians'}, optional) – The units of lats and lons

  • outDimension (str, optional) – The name of the dimension corresponding to the points (i.e. the “horizontal” dimension of the point collection)

  • Author –

  • ------ –

  • Asay-Davis (Xylar) –

  • Modified (Last) –

  • ------------- –

  • 04/19/2017 –

Methods

__init__(lats, lons, collectionName[, …])

Constructor stores

to_esmf(esmfFileName)

Create an ESMF mesh file for the mesh

to_scrip(scripFileName)

Given an MPAS mesh file, create a SCRIP file based on the mesh.