Skip to content

Commit 044db7b

Browse files
committed
Refine README.rst formatting and section headings for consistency
1 parent eb095ad commit 044db7b

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ EnTiSe
55

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

8-
.. .. list-table::
8+
.. list-table::
99
:widths: auto
1010

1111
* - License
@@ -27,12 +27,12 @@ A simple tool for generating time series data related to energy systems and buil
2727
:backlinks: top
2828

2929
Introduction
30-
============
30+
=============
3131
**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.
3232
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.
3333

3434
Key Features
35-
------------
35+
-------------
3636
- Multiple time series types including DHW, HVAC, PV, and more in the works.
3737

3838
- Flexible pipeline- and strategy-based architecture for customizable time series generation.
@@ -43,17 +43,17 @@ Key Features
4343

4444

4545
Getting Started
46-
===============
46+
================
4747
To get started, follow these steps:
4848

4949
Requirements
50-
------------
50+
-------------
5151
- `Python <https://www.python.org/>`_ (3.10 or newer)
5252
- `Git <https://git-scm.com/>`_ for version control (optional, only for development)
5353

5454

5555
Installation
56-
------------
56+
-------------
5757
EnTiSe can be installed directly from PyPI:
5858

5959
.. code-block:: bash
@@ -84,7 +84,7 @@ Or clone the repository and install in development mode:
8484
Now you're ready to use EnTiSe! Check the examples directory for usage examples.
8585

8686
Repository Structure
87-
====================
87+
=====================
8888

8989
- **entise/**: Main project code organized in a Python package.
9090

@@ -97,15 +97,15 @@ Repository Structure
9797
- **examples/**: Example scripts demonstrating usage of the package.
9898

9999
Usage Guidelines
100-
================
100+
=================
101101

102102
Basic Usage
103-
-----------
103+
------------
104104

105105
EnTiSe provides two flexible ways to generate time series data:
106106

107107
Batch Processing
108-
~~~~~~~~~~~~~~~
108+
~~~~~~~~~~~~~~~~~
109109

110110
For generating multiple time series at once:
111111

@@ -137,7 +137,7 @@ For generating multiple time series at once:
137137
summary, df = gen.generate(data)
138138
139139
Direct Method Access
140-
~~~~~~~~~~~~~~~~~~~
140+
~~~~~~~~~~~~~~~~~~~~~
141141

142142
For working with individual methods directly:
143143

@@ -163,7 +163,7 @@ For working with individual methods directly:
163163
For more detailed examples, check the `examples` directory.
164164

165165
Supported or Planned Time Series Types
166-
---------------------------
166+
---------------------------------------
167167
EnTiSe supports generating time series for the following types:
168168

169169
Integrated:
@@ -185,32 +185,32 @@ Planned:
185185
- Wind energy
186186

187187
Documentation
188-
=============
188+
==============
189189

190190
Please see the `documentation <https://entise.readthedocs.io>`_ for further information.
191191

192192

193193
Contribution and Code Quality
194-
=============================
194+
==============================
195195
Everyone is invited to develop this repository.
196196
Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.
197197

198198
Coding Standards
199-
----------------
199+
-----------------
200200
This repository follows consistent coding styles. Refer to `CONTRIBUTING.md <CONTRIBUTING.md>`_ for detailed standards.
201201

202202
Changelog
203-
---------
203+
----------
204204
The changelog is maintained in the `CHANGELOG.md <CHANGELOG.md>`_ file.
205205
It lists all changes made to the repository.
206206
Follow instructions there to document any updates.
207207

208208
License and Citation
209-
====================
209+
=====================
210210
| The code of this repository is licensed under the **MIT License** (MIT).
211211
| See `LICENSE <LICENSE>`_ for rights and obligations.
212212
| See `CITATION.cff <CITATION.cff>`_ for citation of this repository.
213-
| Copyright: `EnTiSe <https://gitlab.lrz.de/tum-ens/need/entise>`_ © `TU Munich - ENS <https://www.epe.ed.tum.de/en/ens/homepage/>`_ | `MIT <LICENSE>`_
213+
| 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>`_
214214
215215

216216
.. |badge_license| image:: https://img.shields.io/badge/license-MIT-blue

0 commit comments

Comments
 (0)