coordinate_reference_systems
============================

.. py:module:: coordinate_reference_systems


Attributes
----------

.. autoapisummary::

   coordinate_reference_systems.CANNOT_TRANSFORM_FIRST
   coordinate_reference_systems.CRS_MAPPING
   coordinate_reference_systems.CYLINDRICAL_COORDINATE_SYSTEMS
   coordinate_reference_systems.DEFAULT_CRS


Functions
---------

.. autoapisummary::

   coordinate_reference_systems.dict_to_crs
   coordinate_reference_systems.is_cylindrical
   coordinate_reference_systems.parse_crs
   coordinate_reference_systems.string_to_crs


Module Contents
---------------

.. py:data:: CANNOT_TRANSFORM_FIRST

.. py:data:: CRS_MAPPING

.. py:data:: CYLINDRICAL_COORDINATE_SYSTEMS

.. py:data:: DEFAULT_CRS

.. py:function:: dict_to_crs(kwargs)

   Convert a dictionary representation of a CRS into a cartopy CRS.

   :param crs: A dictionary representation of a CRS to be parsed and converted into a
               cartopy CRS. Must include a "name" key matching the name of a cartopy
               CRS, plus and keyword arguments to be passed to the CRS constructor.
   :type crs: dict

   .. rubric:: Example

   >>> earthkit.maps.domains.parse_crs(
   ...     {"name": "PlateCarree", "central_longitude": 50}
   ... )
   <Derived Projected CRS: +proj=eqc +ellps=WGS84 +a=6378137.0 +lon_0=50 +to_ ...>
   Name: unknown
   Axis Info [cartesian]:
   - E[east]: Easting (unknown)
   - N[north]: Northing (unknown)
   - h[up]: Ellipsoidal height (metre)
   Area of Use:
   - undefined
   Coordinate Operation:
   - name: unknown
   - method: Equidistant Cylindrical
   Datum: unknown
   - Ellipsoid: WGS 84
   - Prime Meridian: Greenwich

   :rtype: cartopy.crs.CRS


.. py:function:: is_cylindrical(crs)

   Determine whether a CRS is cylindrical.

   :param crs: The coordinate reference system for which to determine whether is is
               cyclindrical.
   :type crs: cartopy.crs.CRS

   :rtype: bool


.. py:function:: parse_crs(crs)

   Convert a string or dictionary representation of a CRS into a cartopy CRS.

   :param crs: Some representation of a CRS to be parsed and converted into a cartopy
               CRS.
               If a string, must be the name of a cartopy CRS.
               If a dictionary, must include a "name" key matching the name of a
               cartopy CRS, plus and keyword arguments to be passed to the CRS
               constructor.
   :type crs: str, dict or cartopy.crs.CRS

   .. rubric:: Example

   >>> earthkit.maps.domains.parse_crs("PlateCarree")
   <Derived Projected CRS: +proj=eqc +ellps=WGS84 +a=6378137.0 +lon_0=0.0 +to ...>
   Name: unknown
   Axis Info [cartesian]:
   - E[east]: Easting (unknown)
   - N[north]: Northing (unknown)
   - h[up]: Ellipsoidal height (metre)
   Area of Use:
   - undefined
   Coordinate Operation:
   - name: unknown
   - method: Equidistant Cylindrical
   Datum: unknown
   - Ellipsoid: WGS 84
   - Prime Meridian: Greenwich
   >>> earthkit.maps.domains.parse_crs(
   ...     {"name": "PlateCarree", "central_longitude": 50}
   ... )
   <Derived Projected CRS: +proj=eqc +ellps=WGS84 +a=6378137.0 +lon_0=50 +to_ ...>
   Name: unknown
   Axis Info [cartesian]:
   - E[east]: Easting (unknown)
   - N[north]: Northing (unknown)
   - h[up]: Ellipsoidal height (metre)
   Area of Use:
   - undefined
   Coordinate Operation:
   - name: unknown
   - method: Equidistant Cylindrical
   Datum: unknown
   - Ellipsoid: WGS 84
   - Prime Meridian: Greenwich

   :rtype: cartopy.crs.CRS


.. py:function:: string_to_crs(string)

   Convert a string name of a CRS into a cartopy CRS.

   :param crs: A string matching the name of a cartopy CRS.
   :type crs: dict

   .. rubric:: Example

   >>> earthkit.maps.domains.parse_crs("PlateCarree")
   <Derived Projected CRS: +proj=eqc +ellps=WGS84 +a=6378137.0 +lon_0=0.0 +to ...>
   Name: unknown
   Axis Info [cartesian]:
   - E[east]: Easting (unknown)
   - N[north]: Northing (unknown)
   - h[up]: Ellipsoidal height (metre)
   Area of Use:
   - undefined
   Coordinate Operation:
   - name: unknown
   - method: Equidistant Cylindrical
   Datum: unknown
   - Ellipsoid: WGS 84
   - Prime Meridian: Greenwich

   :rtype: cartopy.crs.CRS