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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.4.tar.gz
Algorithm Hash digest
SHA256 21161da2dde421ff7a22741a83e261f0d08dbb74049bb4eb64e30bd81a05959d
MD5 20ba50f45d28c0999633bea88dfe0288
BLAKE2b-256 a8ed29900c25007afc7cb3fc33d14798fb2e520495052d3b910b772b75aeb368

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a802b7ae0a3262cd2f79d80e3ea9b3bcd46e8a0bb112c0643520546c055e1f42
MD5 5f54456e256e07e73feddedb1942e93b
BLAKE2b-256 3e3a1718bb0e63f7f671c02d0ea9a75b2fd9e4a7b425bc07511140e844ab1231

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