# Welcome to pyepsg’s documentation!

Provides simple access to http://epsg.io/.

The entry point for this package is the `get()` function.

class pyepsg.Axis(element)

  Bases: `pyepsg.EPSG`

  A single coordinate axis.

  property direction

    A description of the orientation of this axis.

  property uom

    The name of the unit of measure used on this axis.

class pyepsg.CRS(element)

  Bases: `pyepsg.EPSG`

  Abstract parent class for `GeodeticCRS`, `ProjectedCRS` and `CompoundCRS`.

  as_esri_wkt()

    Return the ESRI WKT string which corresponds to the CRS.

    For example:

        >>> print(get(27700).as_esri_wkt())
        PROJCS["OSGB_1936_British_National_Grid",GEOGCS["GCS_OSGB 19...

  as_html()

    Return the OGC WKT which corresponds to the CRS as HTML.

    For example:

        >>> print(get(27700).as_html())
        <div class="syntax"><pre><span class="gh">PROJCS</span><span...

  as_proj4()

    Return the PROJ.4 string which corresponds to the CRS.

    For example:

        >>> print(get(21781).as_proj4())
        +proj=somerc +lat_0=46.95240555555556 +lon_0=7.439583333333333 +k_0=1 +x_0=600000 +y_0=200000 +ellps=bessel +towgs84=674.4,15.1,405.3,0,0,0,0 +units=m +no_defs

  as_wkt()

    Return the OGC WKT string which corresponds to the CRS.

    For example:

        >>> print(get(27700).as_wkt())
        PROJCS["OSGB 1936 / British National Grid",GEOGCS["OSGB 1936...

  domain_of_validity()

    Return the domain of validity for this CRS as: (west, east, south, north).

    For example:

        >>> print(get(21781).domain_of_validity())
        [5.96, 10.49, 45.82, 47.81]

  property id

    The EPSG code for this CRS.

  property name

    The human-readable name.

  property scope

    A human-readable description of the intended usage for this CRS.

class pyepsg.CartesianCS(element)

  Bases: `pyepsg.EPSG`

  A 1-, 2-, or 3-dimensional cartesian coordinate system.

  property axes

    An ordered list of `Axis` objects describing X and Y.

  property name

    The human-readable name.

  property remarks

    Human-readable comments.

class pyepsg.CompoundCRS(element)

  Bases: `pyepsg.CRS`

  Represents a single compound CRS.

class pyepsg.EPSG(element)

  Bases: `object`

  Parent class of all objects returned by pyepsg.

  property identifier

    The official URN for this object.

class pyepsg.GeodeticCRS(element)

  Bases: `pyepsg.CRS`

  Represents a single geodetic CRS.

class pyepsg.ProjectedCRS(element)

  Bases: `pyepsg.CRS`

  Represents a single projected CRS.

  property base_geodetic_crs

    The `GeodeticCRS` on which this projection is based.

  property cartesian_cs

    The `CartesianCS` which describes the coordinate axes.

class pyepsg.UOM(element)

  Bases: `pyepsg.EPSG`

  A unit of measure.

  property name

    The human-readable name.

pyepsg.get(code)

  Return an object that corresponds to the given EPSG code.

  Currently supported object types are:

    - `GeodeticCRS`

    - `ProjectedCRS`

    - `CartesianCS`

    - `UOM`

  For example:

      >>> print(get(27700))
      <ProjectedCRS: 27700, OSGB 1936 / British National Grid>
      >>> print(get('4400-cs'))
      <CartesianCS: Cartesian 2D CS. Axes: easting, northi..>
      >>> print(get(5973))
      <CompoundCRS: 5973, ETRS89 / UTM zone 33 + NN2000 height>