Skip to main content

Timeseries generation library aiming at creating input data for Antares simulator studies.

Project description

antares-timeseries-generation

Timeseries generation library aiming at creating input data for Antares simulator studies.

Install

pip install antares-timeseries-generation

Usage

The generation requires to define a few input data in a ThermalCluster object:

import numpy as np

days = 365
cluster = ThermalCluster(
    unit_count=10,
    nominal_power=100,
    modulation=np.ones(dtype=float, shape=24),
    fo_law=ProbabilityLaw.UNIFORM,
    fo_volatility=0,
    po_law=ProbabilityLaw.UNIFORM,
    po_volatility=0,
    fo_duration=10 * np.ones(dtype=int, shape=days),
    fo_rate=0.2 * np.ones(dtype=float, shape=days),
    po_duration=10 * np.ones(dtype=int, shape=days),
    po_rate=np.zeros(dtype=float, shape=days),
    npo_min=np.zeros(dtype=int, shape=days),
    npo_max=10 * np.ones(dtype=int, shape=days),
)

You then need to provide a random number generator: we provide MersenneTwisterRNG to ensure the same generation as in antares-solver tool.

rng = MersenneTwisterRNG()

Then perform the timeseries generation:

generator = ThermalDataGenerator(rng=rng, days=days)
results = generator.generate_time_series(cluster, 1)

The actual timeseries for the total available power of the cluster are available in the results object as a numpy 2D-array:

print(results.available_power)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

antares_timeseries_generation-0.1.5.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

antares_timeseries_generation-0.1.5-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file antares_timeseries_generation-0.1.5.tar.gz.

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fab31f5fce6d93ba8b3301436ef7c90d5906f7954daa9fe32643eecc2806fdb0
MD5 b77b62ae83ba346f19c29d4e5ac72e16
BLAKE2b-256 f26cb580145d1cd3530d63dd2da8cea5e9fae2b79981ff4eab6a0e2a6b6e9053

See more details on using hashes here.

File details

Details for the file antares_timeseries_generation-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 39953ad831ba85478e21a8cfcd731e32fcb2c9bd6ceddb1fcce9997d1570fbaa
MD5 d0fd1a9ef3b51f36e3aa98610f453a67
BLAKE2b-256 38092cbb7068d3c8d5841563c9cd34302b31e27a06f62969f437c30572b40ef6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page