physt.examples package

Module contents

A set of examples used for demonstrating the physt capabilities / in tests.

physt.examples.fist() → Histogram1D

A simple histogram in the shape of a fist.

physt.examples.load_dataset(name: str) → DataFrame

Load example dataset.

If seaborn is present, its datasets can be loaded. Physt also includes some datasets in CSV format.

physt.examples.munros(edge_length: float = 10) → Histogram2D

Number of munros in different rectangular areas of Scotland.

Parameters:

edge_length (Size of the rectangular grid in minutes.)

Returns:

h – Histogram in latitude and longitude.

Return type:

physt.histogram_nd.Histogram2D

physt.examples.normal_h1(size: int = 10000, mean: float = 0, sigma: float = 1) → Histogram1D

A simple 1D histogram with normal distribution.

Parameters:

• size (Number of points)

• mean (Mean of the distribution)

• sigma (Sigma of the distribution)

physt.examples.normal_h2(size: int = 10000) → Histogram2D

A simple 2D histogram with normal distribution.

Parameters:

size (Number of points)

physt.examples.normal_h3(size: int = 10000) → HistogramND

A simple 3D histogram with normal distribution.

Parameters:

size (Number of points)

physt.examples.show_examples()

Script showing some of the physt examples in the CLI.

You can run this like:

python -m physt.examples