Merge branch 'release/34-release-minor-version-0-2-0' into 'main'

Resolve "Release - Minor Version - 0.2.0"

See merge request tum-ens/need/entise!29

Author: TUM-Doepfert

CHANGELOG.md

@@ -9,6 +9,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ---
 
 ## [Unreleased]
+
+
+## [0.2.0] New architecture, methods and packaging - 2025-06-04
 ### Added
 - Added a simple RC model for HVAC time series (`#12`, `!6`)
 - Added simpler functionality for dependent methods (`#18`, `!12`)

README.rst

@@ -5,7 +5,7 @@ EnTiSe
 
 A simple tool for generating time series data related to energy systems and building operations.
 
-.. .. list-table::
+.. list-table::
    :widths: auto
 
    * - License
@@ -27,12 +27,12 @@ A simple tool for generating time series data related to energy systems and buil
     :backlinks: top
 
 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.
@@ -43,17 +43,17 @@ Key Features
 
 
 Getting Started
-===============
+================
 To get started, follow these steps:
 
 Requirements
-------------
+-------------
 - `Python <https://www.python.org/>`_ (3.10 or newer)
 - `Git <https://git-scm.com/>`_ for version control (optional, only for development)
 
 
 Installation
-------------
+-------------
 EnTiSe can be installed directly from PyPI:
 
 .. code-block:: bash
@@ -84,7 +84,7 @@ Or clone the repository and install in development mode:
 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.
 
@@ -97,15 +97,15 @@ Repository Structure
 - **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:
 
@@ -137,7 +137,7 @@ For generating multiple time series at once:
    summary, df = gen.generate(data)
 
 Direct Method Access
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 For working with individual methods directly:
 
@@ -163,7 +163,7 @@ For working with individual methods directly:
 For more detailed examples, check the `examples` directory.
 
 Supported or Planned Time Series Types
----------------------------
+---------------------------------------
 EnTiSe supports generating time series for the following types:
 
 Integrated:
@@ -185,32 +185,32 @@ Planned:
 - Wind energy
 
 Documentation
-=============
+==============
 
 Please see the `documentation <https://entise.readthedocs.io>`_ for further information.
 
 
 Contribution and Code Quality
-=============================
+==============================
 Everyone is invited to develop this repository.
 Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.
 
 Coding Standards
-----------------
+-----------------
 This repository follows consistent coding styles. Refer to `CONTRIBUTING.md <CONTRIBUTING.md>`_ for detailed standards.
 
 Changelog
----------
+----------
 The changelog is maintained in the `CHANGELOG.md <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 <LICENSE>`_ for rights and obligations.
 | See `CITATION.cff <CITATION.cff>`_ for citation of this repository.
-| Copyright: `EnTiSe <https://gitlab.lrz.de/tum-ens/need/entise>`_ © `TU Munich - ENS <https://www.epe.ed.tum.de/en/ens/homepage/>`_ | `MIT <LICENSE>`_
+| Copyright: `EnTiSe <https://gitlab.lrz.de/tum-ens/need/entise>`_ (c) `TU Munich - ENS <https://www.epe.ed.tum.de/en/ens/homepage/>`_ | `MIT <LICENSE>`_
 
 
 .. |badge_license| image:: https://img.shields.io/badge/license-MIT-blue

USERS.cff

@@ -25,24 +25,24 @@ It always has the format `YYYY-MM-DD`, e.g. `1992-11-07`.
 - 📝 **Version Entry**: Format the new version entry as follows:
     ```
     ## [0.1.0] - 2022-01-01
-  
+
     ### Added
     - New feature
     - Another new feature
-  
+
     ### Changed
     - Change to existing feature
-  
+
     ### Fixed
     - Bug fix
     ```
-  
+
 ### 2. Create a `Draft GitLab Release` Issue
 - 🐙 **Template**: Use the `📝Release_Checklist` template for the issue.
 - 🐙 **Issue**: Create a new issue in the repository with the title `Release - Minor Version - 0.1.0`.
 - 🐙 **Description**: Fill in the details of the release, including the name, Git tag, release manager, and date.
 - 🐙 **Workflow Checklist**: Check off the steps in the workflow checklist for the release.
-  
+
 ### 3. Update Version in Code
 - 📝 **File**: Locate the version variable in the code (in the template it can be found in [VERSION](VERSION)).
 - 💻 **Update**: Change the version number to the new release version following SemVer.
@@ -62,7 +62,7 @@ It always has the format `YYYY-MM-DD`, e.g. `1992-11-07`.
     ```bash
     git push --set-upstream origin release-1.5.0
     ```
-  
+
 ### 5. Finalize and Merge
 - 🐙 **Merge Request**: In GitLab, open a merge request (MR) from `release-1.5.0` into `main`.
 - 🐙 **Review**: Assign reviewers to the MR and ensure all tests pass.
@@ -79,7 +79,7 @@ It always has the format `YYYY-MM-DD`, e.g. `1992-11-07`.
     git tag -a v1.5.0 -m "Release 1.5.0"
     git push origin v1.5.0
     ```
-  
+
 ### 7. Create a GitLab Release (Optional)
 - 🐙 **GitLab Release Page**: Go to the GitLab project’s Releases section and create a new release linked to the v1.5.0 tag.
 - 📝 **Release Notes**: Add release notes using information from the changelog.
@@ -145,4 +145,3 @@ git push
 - **Versioning**: Always increment the version correctly using `bump2version` before creating the final release.
 - **Publishing Reminder**: Ensure your PyPI credentials are correctly set up in GitLab CI/CD or local `.pypirc` configuration for seamless uploads.
 - **Final Check**: If issues arise post-release, refer to the [GitLab CI/CD guide](https://docs.gitlab.com/ee/development/cicd/) and [PyPI documentation](https://packaging.python.org/en/latest/) for troubleshooting.
-