polartoolkit.default_epsg

default_epsg(epsg, hemisphere)

Returns the provided EPSG code through 1 of 4 methods in the following preference. 1) the parameter epsg which is an EPSG code as a string (“3031”) 2) the parameter hemisphere which is either the strings “north” or “south” (which correspond to EPSG codes 3413 and 3031 respectively), 3) the user-set environment variable POLARTOOLKIT_EPSG which should be a EPSG code as a string (“3031”) or 4) the user-set environment variable POLARTOOLKIT_HEMISPHERE which should be set to “north” or “south” (which correspond to EPSG codes 3413 and 3031 respectively). If none of these are provided, an error is raised informing the user how to set the values.

Parameters:

• epsg (str | None) – an EPSG code as a string (“3031”), by default None.

• hemisphere (str | None) – hemisphere to use, either “north” or “south”, corresponding to EPSG codes 3413 and 3031 respectively, by default None.

Returns:

EPSG code to use

Return type:

str