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

Necessity to say that pandas~=2.2.3 requires python version 3.9 or newer versions

Usage

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

import numpy as np

days = 365
generation_params = OutageGenerationParameters(
    unit_count=10,
    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)
)
cluster = ThermalCluster(
    outage_gen_params=generation_params,
    nominal_power=100,
    modulation=np.ones(dtype=float, shape=24),
)

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 = TimeSeriesGenerator(rng=rng, days=days)
results = generator.generate_time_series_for_clusters(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.7.tar.gz (21.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.7-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.7.tar.gz
Algorithm Hash digest
SHA256 55d7a25e973a4f936f8487cb84d908915b0cfb57dd34f8cc85417f275fc02574
MD5 06e30372a2306f8e62cc6d3c2c188956
BLAKE2b-256 29c61620f97ca2a8190c450c2c5a4a9dfbad5aebc28c5e7c234f5ce45aee8d1d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e3c47692b3a104d11aeb38b1f4b7750326df36d390a88d8428c87005da129b68
MD5 1981e4737e76549f96b1b468e2fe3c62
BLAKE2b-256 79bc3ab356c08d36c8a290c119712328b521e3d40e83b6043fc680f3fabb5837

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