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.8.tar.gz (21.5 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.8-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.8.tar.gz
Algorithm Hash digest
SHA256 eabaedbd6a3bfad1dc17c5e6b3f40078ecafc5e12282a7bc452b216a9da098b5
MD5 1f80de412ff66fd197752089ffb86b39
BLAKE2b-256 c6ef567ec31e13c1076e1eebd6b10cb1a8fa74d00a6993b6efb9e26ff3111f84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 cacf68666ccb7d97673fe434306b4a87f1e21d401c820cbdb1bdf7f1c40ac6f3
MD5 44586522ade9810d94bdd8a605aeab09
BLAKE2b-256 ca5541126f6730581a70b608d7ae18d8e8428bd2f33aba4e03f279618c139ad1

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