pdstools.utils.datasets

Functions

cdh_sample(→ pdstools.adm.ADMDatamart.ADMDatamart)	Import a sample dataset from the CDH Sample application
sample_trees()
sample_value_finder(...)	Import a sample dataset of a Value Finder simulation

Module Contents

cdh_sample(query: pdstools.utils.types.QUERY | None = None) → pdstools.adm.ADMDatamart.ADMDatamart

Import a sample dataset from the CDH Sample application

Parameters:

query (Optional[QUERY], optional) – An optional query to apply to the data, by default None

Returns:

The ADM Datamart class populated with CDH Sample data

Return type:

ADMDatamart

sample_trees()

sample_value_finder(threshold: float | None = None) → pdstools.valuefinder.ValueFinder.ValueFinder

Import a sample dataset of a Value Finder simulation

This simulation was ran on a stock CDH Sample system.

Parameters:

threshold (Optional[float], optional) – Optional override of the propensity threshold in the system, by default None

Returns:

The Value Finder class populated with the Value Finder simulation data

Return type:

ValueFinder