API#

Core Classes#

Unit-aware data structures for scalar values, arrays, and dataframes.

antupy.Var([_value, _unit])

Class to represent parameters and variables in the system.

antupy.Array([_value, _unit])

A container for homogeneous numerical data with associated physical units.

antupy.Frame([data, index, columns, dtype, ...])

Enhanced DataFrame with unit tracking capabilities.

antupy.CF(unit1, unit2)

Conversion factor between two units.

antupy.Unit([unit, base_factor])

Class containing any unit valid with SI unit system.

System Classes#

Classes for modeling thermal systems and running parametric analyses.

antupy.Plant(out, constraints, ...]] =)

Plant base class with component management.

antupy.Simulation(out)

antupy.SimulationOutput

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2).

antupy.Parametric(base_case, params_in[, ...])

Enhanced parametric analysis manager with full unit tracking.

Time Series Generators (TSG)#

Weather data, Market data and other time series generation classes.

antupy.tsg.settings.TimeParams(START, STOP, ...)

Time parameters for simulations.

antupy.tsg.mkt.Market(*args, **kwargs)

Protocol for electricity market data loaders.

antupy.tsg.mkt.MarketAU([state, year_i, ...])

antupy.tsg.mkt.MarketCL([location, year_i, ...])

Chilean electricity market data loader (SEN - Sistema Eléctrico Nacional).

antupy.tsg.weather.Weather(*args, **kwargs)

Weather generator protocol.

antupy.tsg.weather.TMY(dataset, location, ...)

TMY (Typical Meteorological Year) weather generator.

antupy.tsg.weather.WeatherMC(dataset, ...)

Monte Carlo weather generator.

antupy.tsg.weather.WeatherHist(dataset, ...)

Historical weather generator.

antupy.tsg.weather.WeatherConstantDay(...)

Constant day weather generator.

Utilities#

Helper functions and classes for locations, heat transfer, thermophysical properties, and solar calculations.

antupy.loc.Location(*args, **kwargs)

Protocol for location classes.

antupy.loc.LocationAU([value])

antupy.loc.LocationCL(value)

Thermophysical Properties#

Available Materials (provide rho(T), cp(T), k(T) methods):

antupy.props.SolarSalt()

antupy.props.Carbo(*args, **kwargs)

antupy.props.Aluminium()

antupy.props.Copper()

antupy.props.CopperNickel()

antupy.props.StainlessSteel()

antupy.props.Glass()

Available Fluids (provide additional mu(T), h(T), Pr(T) and other fluid properties):

antupy.props.SaturatedWater()

antupy.props.SaturatedSteam()

antupy.props.SeaWater()

antupy.props.Air()

antupy.props.HumidAir()

antupy.props.CO2()

antupy.props.TherminolVP1()

antupy.props.Syltherm800()