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.2.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.2-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c3ba617c7b690d7b4ebef06f8b5aea358d460c99260d4a5ff7ebd4354e143c2e
MD5 811cd4623df9d57d36c6ab525e0f5aae
BLAKE2b-256 286020d64af17128acb141a5a8c07c8ba1d90d8549dbfd082ef48eaba436a01a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 58b9c87c809983a4424506b496fc0d2bd03f2c4ffbe7a1fb928be201669a92db
MD5 9358a4fbd40ee8c3a6c24bde6f1dc89e
BLAKE2b-256 45df5067b3fce188f9278c6120b8c6f6ad4b1ea05f39c93b58158a1323d615e3

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