Parameters and Configuration#

The pygeostat.pygeostat_parameters module provides the global parameter system for configuring pygeostat behavior and plot styling.

Parameters Class#

pygeostat.pygeostat_parameters.Parameters[source]#

alias of {‘config.autoload.parameters’: True, ‘config.autoload.plot_style’: False, ‘config.getpar’: False, ‘config.ignore_mpl_warnings’: True, ‘config.nprocess’: 4, ‘config.use_shipped_executable’: True, ‘config.verbose’: True, ‘data.cat’: None, ‘data.catdict’: None, ‘data.dh’: None, ‘data.fix_legacy_null’: False, ‘data.griddef’: None, ‘data.ifrom’: None, ‘data.io.pandas_engine’: ‘python’, ‘data.ito’: None, ‘data.legacy_null’: [-999, -998, -99, -98], ‘data.nreal’: None, ‘data.null’: -999.0, ‘data.null_vtk’: 0.0, ‘data.tmin’: -998.0, ‘data.weights’: None, ‘data.write.python_floatfmt’: ‘%.6f’, ‘data.write_vtk.cdtype’: ‘float64’, ‘data.write_vtk.vdtype’: ‘float64’, ‘data.x’: None, ‘data.y’: None, ‘data.z’: None, ‘plotting.assumecat’: 11, ‘plotting.axis_xy’: False, ‘plotting.axis_xy_spatial’: False, ‘plotting.cmap’: ‘viridis’, ‘plotting.cmap_cat’: ‘tab20’, ‘plotting.gammasize’: 3.0, ‘plotting.grid’: False, ‘plotting.histogram_plot.cdfcolor’: ‘.5’, ‘plotting.histogram_plot.edgecolor’: ‘k’, ‘plotting.histogram_plot.edgeweight’: None, ‘plotting.histogram_plot.facecolor’: ‘.9’, ‘plotting.histogram_plot.histbins’: 15, ‘plotting.histogram_plot.stat_blk’: ‘all’, ‘plotting.histogram_plot.stat_xy’: [0.95, 0.95], ‘plotting.histogram_plot.stat_xy_cdf’: [0.95, 0.05], ‘plotting.histogram_plot_simulation.alpha’: 0.5, ‘plotting.histogram_plot_simulation.refclr’: ‘C3’, ‘plotting.histogram_plot_simulation.simclr’: ‘0.2’, ‘plotting.lagname’: ‘Lag Distance’, ‘plotting.location_plot.c’: ‘.4’, ‘plotting.location_plot.lw’: 5.0, ‘plotting.location_plot.s’: 20.0, ‘plotting.log_lowerval’: 0.0001, ‘plotting.nticks’: None, ‘plotting.rotateticks’: [0, 0], ‘plotting.roundstats’: True, ‘plotting.scatter_plot.alpha’: 1.0, ‘plotting.scatter_plot.c’: ‘kde’, ‘plotting.scatter_plot.cmap’: ‘viridis’, ‘plotting.scatter_plot.s’: None, ‘plotting.scatter_plot.stat_blk’: ‘pearson’, ‘plotting.scatter_plot.stat_xy’: [0.95, 0.05], ‘plotting.sigfigs’: 2, ‘plotting.stat_fontsize’: None, ‘plotting.stat_ha’: ‘right’, ‘plotting.stat_linespacing’: 1.0, ‘plotting.unit’: ‘m’, ‘plotting.variogram_plot.color’: ‘.5’, ‘plotting.variogram_plot.ms’: 6.0, ‘plotting.variogram_plot_simulation.alpha’: 0.5, ‘plotting.variogram_plot_simulation.refclr’: ‘C3’, ‘plotting.variogram_plot_simulation.simclr’: ‘0.2’, ‘plotting.vplot.colors’: [‘C0’, ‘C1’, ‘C2’], ‘plotting.xabbrev’: ‘E’, ‘plotting.xname’: ‘Easting’, ‘plotting.yabbrev’: ‘N’, ‘plotting.yname’: ‘Northing’, ‘plotting.zabbrev’: ‘Elev’, ‘plotting.zname’: ‘Elevation’}

PlotStyle Class#

pygeostat.pygeostat_parameters.PlotStyle[source]#

alias of {‘axes.axisbelow’: True, ‘axes.edgecolor’: ‘black’, ‘axes.facecolor’: ‘white’, ‘axes.grid’: False, ‘axes.labelcolor’: ‘black’, ‘axes.labelsize’: 8, ‘axes.linewidth’: 0.5, ‘axes.titlesize’: 10, ‘figure.edgecolor’: ‘black’, ‘figure.facecolor’: ‘white’, ‘figure.figsize’: (8, 8), ‘figure.subplot.bottom’: 0.125, ‘font.family’: ‘Calibri’, ‘font.size’: 12, ‘font.weight’: 400, ‘grid.color’: ‘lightgray’, ‘grid.linestyle’: ‘-’, ‘grid.linewidth’: 0.5, ‘legend.fontsize’: 8.0, ‘legend.frameon’: False, ‘legend.numpoints’: 1, ‘legend.scatterpoints’: 1, ‘lines.linewidth’: 1.5, ‘lines.markeredgewidth’: 0, ‘lines.markersize’: 7, ‘lines.solid_capstyle’: ‘round’, ‘patch.linewidth’: 0.3, ‘pdf.fonttype’: 3, ‘ps.fonttype’: 3, ‘ps.useafm’: True, ‘text.color’: ‘black’, ‘xtick.color’: ‘black’, ‘xtick.direction’: ‘out’, ‘xtick.labelsize’: 11, ‘xtick.major.pad’: 3, ‘xtick.major.size’: 0, ‘xtick.major.width’: 1, ‘xtick.minor.size’: 0, ‘xtick.minor.width’: 0.5, ‘ytick.color’: ‘black’, ‘ytick.direction’: ‘out’, ‘ytick.labelsize’: 11, ‘ytick.major.pad’: 3, ‘ytick.major.size’: 0, ‘ytick.major.width’: 1, ‘ytick.minor.size’: 0, ‘ytick.minor.width’: 0.5}

Initialization Functions#

_parameters_initialize#

pygeostat.pygeostat_parameters._parameters_initialize()[source]#

_plot_style_initilizer#

pygeostat.pygeostat_parameters._plot_style_initilizer()[source]#

File I/O#

_write_pardict#

pygeostat.pygeostat_parameters._write_pardict(filename, dictionary, section, description=None)[source]#

_parse_pardict#

pygeostat.pygeostat_parameters._parse_pardict(filename, section)[source]#