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.6.tar.gz (19.6 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.6-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.6.tar.gz
Algorithm Hash digest
SHA256 607947d37229ca42ff4a5d190d3cf160446d9a6a0b8eae36d5b12a85d3e5c8c5
MD5 8b06257e6ac9e67a52e91f2613c41803
BLAKE2b-256 8973d44a53ef6a8af596f12e14ad0547363089f4cec8a3fc5383405f4c855acd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 72793c0ecf7eb7082d119de7bbecd019dfd5e9f3f09001546278bc1619376c59
MD5 6e19bf79dce4b6874a80234c88f26a06
BLAKE2b-256 70b78d3e309c93d14ccec83a7978005d31ed2bfcef4e83904c50a9dcaac8af52

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