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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.9.tar.gz
Algorithm Hash digest
SHA256 0c19a3f56e424ac3105686691ff1d1ef6c0320244af986e852698dc9b71619c6
MD5 289e029cef570223fa4b382ed83011f7
BLAKE2b-256 2d6eb59a4f1c6f24ff1d32d40cc58184a7b5e14f187f119f3f7ce076ea6a9946

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for antares_timeseries_generation-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e69799290b9f29e8ed2ebc6ad49ce128a8559fc4af5804428eb620801295e4c4
MD5 86f67459a316e80a323afdd7e613a01b
BLAKE2b-256 5ce4a81417ac4ac1607aab01b5e91f5de9d202688348d5af687aa4629d7367ff

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