entise 1.0.0

A tool for generating time series data related to energy systems and building operations

A simple tool for generating time series data related to energy systems and building operations.

License
Package
Build Status
Documentation
Development
Community

• Introduction

• Getting Started

• Repository Structure

• Usage Guidelines

• Documentation

• Contribution and Code Quality

• License and Citation

Introduction

EnTiSe (En-ergy Ti-me Se-ries) is a Python package designed to generate realistic time series data for various energy systems and building operations. It provides a flexible, pipeline- and strategy-based approach to create time series for different applications including HVAC, domestic hot water, electricity, mobility, and occupancy patterns.

Key Features

• Multiple time series types including DHW, HVAC, PV, and more in the works.

• Flexible pipeline- and strategy-based architecture for customizable time series generation.

• Support for dependent methods to create related time series.

• Two access patterns: batch processing via TimeSeriesGenerator or direct method imports for individual control.

Getting Started

To get started, follow these steps:

Requirements

• Python (3.10 or newer)

• Git for version control (optional, only for development)

Installation

EnTiSe can be installed directly from PyPI:

pip install entise

For faster installation, you can use uv:

pip install uv
uv pip install entise

For development or the latest features, you can install directly from the repository:

pip install git+https://github.com/tum-ens/need/entise.git

Or clone the repository and install in development mode:

git clone https://github.com/tum-ens/need/entise.git
cd entise
pip install -e ".[dev]"

Now you’re ready to use EnTiSe! Check the examples directory for usage examples.

Repository Structure

• entise/: Main project code organized in a Python package.

  • constants/: Definitions of time series types and other constants.

  • core/: Core functionality and base classes.

  • data/: Data files and data handling utilities.

  • methods/: Implementation of various time series generation methods.

• tests/: Folder for tests; structured by functionality.

• docs/: Documentation source files.

• examples/: Example scripts demonstrating usage of the package.

Usage Guidelines

Basic Usage

EnTiSe provides two flexible ways to generate time series data:

Batch Processing

For generating multiple time series at once:

from entise.core.generator import TimeSeriesGenerator

# Initialize the generator
gen = TimeSeriesGenerator()

# Add objects (e.g., buildings)
gen.add_objects({
    "id": "building1",
    "hvac": "1R1C",
    "resistance": 2.0,
    "capacitance": 1e5,
    "temp_min": 20.0,
    "temp_max": 24.0,
})

# Prepare input data (e.g., weather)
data = {
    "weather": pd.DataFrame({
        "temp_out": [0.0] * 24,
    }, index=pd.date_range("2025-01-01", periods=24, freq="h"))
}

# Generate time series
summary, df = gen.generate(data)

Direct Method Access

For working with individual methods directly:

from entise.methods.pv import PVLib

# Create an instance
pvlib = PVLib()

# Generate time series
result = pvlib.generate(
    latitude=48.1,
    longitude=11.6,
    power=5000,
    weather=weather_df
)

# Access results
summary = result["summary"]
timeseries = result["timeseries"]

For more detailed examples, check the examples directory.

Supported or Planned Time Series Types

EnTiSe supports generating time series for the following types:

Integrated:

• Domestic Hot Water (DHW)

• HVAC (Heating, Ventilation, and Air Conditioning)

• Occupancy data

• Solar Photovoltaic (PV)

Planned:

• Concentrated Solar Power (CSP)

• Electricity demand or supply

• Geothermal energy

• Hydroelectric power

• Mobility (transportation-related data)

• Tidal energy

• Wave energy

• Wind energy

Documentation

Please see the documentation for further information.

Contribution and Code Quality

Everyone is invited to develop this repository. Please follow the workflow described in the CONTRIBUTING.md.

Coding Standards

This repository follows consistent coding styles. Refer to CONTRIBUTING.md for detailed standards.

Changelog

The changelog is maintained in the CHANGELOG.md file. It lists all changes made to the repository. Follow instructions there to document any updates.

License and Citation

The code of this repository is licensed under the MIT License (MIT).

See LICENSE for rights and obligations.

See CITATION.cff for citation of this repository.

Copyright: EnTiSe (c) TU Munich - ENS | MIT