.. config:


config
======

.. code::

	classpygmt.config(\*, COLOR_BACKGROUND=None, COLOR_FOREGROUND=None,
	COLOR_CPT=None, COLOR_NAN=None, COLOR_MODEL=None, COLOR_HSV_MIN_S=None,
	COLOR_HSV_MAX_S=None, COLOR_HSV_MIN_V=None, COLOR_HSV_MAX_V=None,
	COLOR_SET=None, DIR_CACHE=None, DIR_DATA=None, DIR_DCW=None,
	DIR_GSHHG=None, FONT_ANNOT_PRIMARY=None, FONT_ANNOT_SECONDARY=None, 
	FONT_HEADING=None, FONT_LABEL=None, FONT_LOGO=None, FONT_SUBTITLE=None, 
	FONT_TAG=None, FONT_TITLE=None, FORMAT_CLOCK_IN=None, FORMAT_CLOCK_OUT=None, 
	FORMAT_CLOCK_MAP=None, FORMAT_DATE_IN=None, FORMAT_DATE_OUT=None, 
	FORMAT_DATE_MAP=None, FORMAT_GEO_OUT=None, FORMAT_GEO_MAP=None, 
	FORMAT_FLOAT_OUT=None, FORMAT_FLOAT_MAP=None, FORMAT_TIME_PRIMARY_MAP=None, 
	FORMAT_TIME_SECONDARY_MAP=None, FORMAT_TIME_STAMP=None, GMT_DATA_SERVER=None, 
	GMT_DATA_SERVER_LIMIT=None, GMT_DATA_UPDATE_INTERVAL=None, 
	GMT_COMPATIBILITY=None, GMT_CUSTOM_LIBS=None, GMT_EXPORT_TYPE=None, 
	GMT_EXTRAPOLATE_VAL=None, GMT_FFT=None, GMT_GRAPHICS_DPU=None, 
	GMT_GRAPHICS_FORMAT=None, GMT_HISTORY=None, GMT_INTERPOLANT=None, 
	GMT_LANGUAGE=None, GMT_MAX_CORES=None, GMT_THEME=None, GMT_TRIANGULATE=None, 
	GMT_VERBOSE=None, IO_COL_SEPARATOR=None, IO_FIRST_HEADER=None, 
	IO_GRIDFILE_FORMAT=None, IO_GRIDFILE_SHORTHAND=None, IO_HEADER=None, 
	IO_HEADER_MARKER=None, IO_N_HEADER_RECS=None, IO_NAN_RECORDS=None, 
	IO_NC4_CHUNK_SIZE=None, IO_NC4_DEFLATION_LEVEL=None, IO_LONLAT_TOGGLE=None, 
	IO_SEGMENT_BINARY=None, IO_SEGMENT_MARKER=None, MAP_ANNOT_MIN_ANGLE=None, 
	MAP_ANNOT_MIN_SPACING=None, MAP_ANNOT_OBLIQUE=None, 
	MAP_ANNOT_OFFSET_PRIMARY=None, MAP_ANNOT_OFFSET_SECONDARY=None, 
	MAP_ANNOT_ORTHO=None, MAP_DEFAULT_PEN=None, MAP_DEGREE_SYMBOL=None, 
	MAP_EMBELLISHMENT_MODE=None, MAP_FRAME_AXES=None, MAP_FRAME_PEN=None, 
	MAP_FRAME_PERCENT=None, MAP_FRAME_TYPE=None, MAP_FRAME_WIDTH=None, 
	MAP_GRID_CROSS_SIZE_PRIMARY=None, MAP_GRID_CROSS_SIZE_SECONDARY=None, 
	MAP_GRID_PEN_PRIMARY=None, MAP_GRID_PEN_SECONDARY=None, 
	MAP_HEADING_OFFSET=None, MAP_LABEL_MODE=None, MAP_LABEL_OFFSET=None, 
	MAP_LINE_STEP=None, MAP_LOGO=None, MAP_LOGO_POS=None, MAP_ORIGIN_X=None, 
	MAP_ORIGIN_Y=None, MAP_POLAR_CAP=None, MAP_SCALE_HEIGHT=None, 
	MAP_TICK_LENGTH_PRIMARY=None, MAP_TICK_LENGTH_SECONDARY=None, 
	MAP_TICK_PEN_PRIMARY=None, MAP_TICK_PEN_SECONDARY=None, 
	MAP_TITLE_OFFSET=None, MAP_VECTOR_SHAPE=None, PROJ_AUX_LATITUDE=None, 
	PROJ_DATUM=None, PROJ_ELLIPSOID=None, PROJ_GEODESIC=None, 
	PROJ_LENGTH_UNIT=None, PROJ_MEAN_RADIUS=None, PROJ_SCALE_FACTOR=None, 
	PS_CHAR_ENCODING=None, PS_COLOR_MODEL=None, PS_COMMENTS=None, 
	PS_CONVERT=None, PS_IMAGE_COMPRESS=None, PS_LINE_CAP=None, PS_LINE_JOIN=None, 
	PS_MITER_LIMIT=None, PS_MEDIA=None, PS_PAGE_COLOR=None, 
	PS_PAGE_ORIENTATION=None, PS_SCALE_X=None, PS_SCALE_Y=None, 
	PS_TRANSPARENCY=None, TIME_EPOCH=None, TIME_IS_INTERVAL=None, 
	TIME_INTERVAL_FRACTION=None, TIME_LEAP_SECONDS=None, TIME_REPORT=None, 
	TIME_UNIT=None, TIME_WEEK_START=None, TIME_Y2K_OFFSET_YEAR=None, FONT=None, 
	FONT_ANNOT=None, FORMAT_TIME_MAP=None, MAP_ANNOT_OFFSET=None, 
	MAP_GRID_CROSS_SIZE=None, MAP_GRID_PEN=None, MAP_TICK_LENGTH=None, 
	MAP_TICK_PEN=None)
	


Définissez les valeurs GMT par défaut globalement ou localement.

Modifiez globalement les paramètres GMT par défaut :

.. code::
	
	pygmt.config(PARAMETER=value)
	

Modifiez les paramètres GMT par défaut localement en l'utilisant comme gestionnaire de contexte :

.. code::

	with pygmt.config(PARAMETER=value):
    	\...

Exemples
--------


.. code::
	
	from pygmt.datasets import load_earth_relief
	# Use the global Earth relief grid with 1 degree spacing
	grid = load_earth_relief(resolution="01d", registration="pixel")
	# See if grid uses Gridline (0) or Pixel (1) registration
	grid.gmt.registration
	1
	# See if grid uses Cartesian (0) or Geographic (1) coordinate system
	grid.gmt.gtype
	1

	(0, 1)
	
L'accès à a `xarray.DataArray` depuis a `xarray.Dataset` crée toujours de nouvelles instances, donc ces propriétés sont toujours perdues. La solution consiste à affecter le `xarray.DataArray` dans une variable :


.. code::

	ds = xr.Dataset({"zval": grid})
	ds.zval.gmt.registration, ds.zval.gmt.gtype
	(0, 0)
	# manually set these properties won't work as expected
	ds.zval.gmt.registration, ds.zval.gmt.gtype = 0, 1
	ds.zval.gmt.registration, ds.zval.gmt.gtype
	(0, 0)
	# workaround: assign the DataArray into a variable
	zval = ds.zval
	zval.gmt.registration, zval.gmt.gtype
	(0, 0)
	zval.gmt.registration, zval.gmt.gtype = 0, 1
	zval.gmt.registration, zval.gmt.gtype
	(0, 1)


Les attributs
-------------

.. code::
	
	import pygmt
	
	# Define region of interest around Yosemite valley
	region = [-119.825, -119.4, 37.6, 37.825]
	
	# Load sample grid (3 arc-seconds global relief) in target area
	grid = pygmt.datasets.load_earth_relief(resolution="03s", region=region)
	
	# calculate the reflection of a light source projecting from west to east
	# (azimuth of 270 degrees) and at a latitude of 30 degrees from the horizon
	dgrid = pygmt.grdgradient(grid=grid, radiance=[270, 30])
	
	fig = pygmt.Figure()
	# define figure configuration
	pygmt.config(FORMAT_GEO_MAP="ddd.x", MAP_FRAME_TYPE="plain")
	
	# --------------- plotting the original Data Elevation Model -----------
	
	pygmt.makecpt(cmap="gray", series=[200, 4000, 10])
	fig.grdimage(
	    grid=grid,
	    projection="M12c",
	    frame=["WSrt+tOriginal Data Elevation Model", "xa0.1", "ya0.1"],
	    cmap=True,
	)
	
	fig.colorbar(position="JML+o1.4c/0c+w7c/0.5c", frame=["xa1000f500+lElevation", "y+lm"])
	
	# --------------- plotting the hillshade map -----------
	
	# Shift plot origin of the second map by 12.5 cm in x direction
	fig.shift_origin(xshift="12.5c")
	
	pygmt.makecpt(cmap="gray", series=[-1.5, 0.3, 0.01])
	fig.grdimage(
	    grid=dgrid,
	    projection="M12c",
	    frame=["lSEt+tHillshade Map", "xa0.1", "ya0.1"],
	    cmap=True,
	)

	fig.show()