Summary Plots¶
This module handles some basic return for the summary plots.
Requires a LiPD file
-
pyleoclim.SummaryPlots.
getMetadata
(timeseries)¶ Get the necessary metadata to be printed out automatically
- Args:
timeseries: a specific timeseries object.
- Returns:
A dictionary containing the following metadata:
archiveType
Authors (if more than 2, replace by et al.
PublicationYear
Publication DOI
Variable Name
Units
Climate Interpretation
Calibration Equation
Calibration References
Calibration Notes
-
pyleoclim.SummaryPlots.
TsData
(timeseries, x_axis='')¶ Get the PaleoData with age/depth information
Get the necessary information for the TS plots/necessary to allow for axes specification
- Args:
- timeseries: a single timeseries object.
By default, will prompt the user
- x-axis (str): The representation against which to plot the
paleo-data. Options are “age”, “year”, and “depth”. Default is to let the system choose if only one available or prompt the user.
- Returns:
x - the x-valus
y - the y-values
archiveType - the archiveType (for plot settings)
x_label - the label for the x-axis
y_label - the label for the y-axis
label - the results of the x-axis query. Either depth, year, or age
-
pyleoclim.SummaryPlots.
agemodelData
(timeseries)¶ Get the necessary information for the agemodel plot
- Args:
- timeseries: a single timeseries object. By default, will
prompt the user
- Returns:
depth - the depth values
age - the age values
x_label - the label for the x-axis
y_label - the label for the y-axis
archiveType - the archiveType (for default plot settings)