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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fd090626b8e1a09dc6e512c5d052e1dea5a3e5fb67e822f5423aa664e3054b57
MD5 6dc2ee5a3e03729f555b8f1ade4373c5
BLAKE2b-256 de28bc8e9107489ca2558a9fd8d01432560dd5e45900acb1a48988094ce50d7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e36b56b1270f4db2102520b85a41e73c033e0d1436d0ee6545c28db2f8d02ddc
MD5 b37e5e317d09fd5be0b74bb58e3d6c3f
BLAKE2b-256 5ce5f76271f46565d38a5aa847ede28faa1dc0f69cadee9aec7bd5f9d254f114

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