You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ EnTiSe
5
5
6
6
A simple tool for generating time series data related to energy systems and building operations.
7
7
8
-
.. .. list-table::
8
+
.. list-table::
9
9
:widths: auto
10
10
11
11
* - License
@@ -27,12 +27,12 @@ A simple tool for generating time series data related to energy systems and buil
27
27
:backlinks: top
28
28
29
29
Introduction
30
-
============
30
+
=============
31
31
**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.
32
32
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.
33
33
34
34
Key Features
35
-
------------
35
+
-------------
36
36
- Multiple time series types including DHW, HVAC, PV, and more in the works.
37
37
38
38
- Flexible pipeline- and strategy-based architecture for customizable time series generation.
@@ -43,17 +43,17 @@ Key Features
43
43
44
44
45
45
Getting Started
46
-
===============
46
+
================
47
47
To get started, follow these steps:
48
48
49
49
Requirements
50
-
------------
50
+
-------------
51
51
- `Python <https://www.python.org/>`_ (3.10 or newer)
52
52
- `Git <https://git-scm.com/>`_ for version control (optional, only for development)
53
53
54
54
55
55
Installation
56
-
------------
56
+
-------------
57
57
EnTiSe can be installed directly from PyPI:
58
58
59
59
.. code-block:: bash
@@ -84,7 +84,7 @@ Or clone the repository and install in development mode:
84
84
Now you're ready to use EnTiSe! Check the examples directory for usage examples.
85
85
86
86
Repository Structure
87
-
====================
87
+
=====================
88
88
89
89
- **entise/**: Main project code organized in a Python package.
90
90
@@ -97,15 +97,15 @@ Repository Structure
97
97
- **examples/**: Example scripts demonstrating usage of the package.
98
98
99
99
Usage Guidelines
100
-
================
100
+
=================
101
101
102
102
Basic Usage
103
-
-----------
103
+
------------
104
104
105
105
EnTiSe provides two flexible ways to generate time series data:
106
106
107
107
Batch Processing
108
-
~~~~~~~~~~~~~~~
108
+
~~~~~~~~~~~~~~~~~
109
109
110
110
For generating multiple time series at once:
111
111
@@ -137,7 +137,7 @@ For generating multiple time series at once:
137
137
summary, df = gen.generate(data)
138
138
139
139
Direct Method Access
140
-
~~~~~~~~~~~~~~~~~~~
140
+
~~~~~~~~~~~~~~~~~~~~~
141
141
142
142
For working with individual methods directly:
143
143
@@ -163,7 +163,7 @@ For working with individual methods directly:
163
163
For more detailed examples, check the `examples` directory.
164
164
165
165
Supported or Planned Time Series Types
166
-
---------------------------
166
+
---------------------------------------
167
167
EnTiSe supports generating time series for the following types:
168
168
169
169
Integrated:
@@ -185,32 +185,32 @@ Planned:
185
185
- Wind energy
186
186
187
187
Documentation
188
-
=============
188
+
==============
189
189
190
190
Please see the `documentation <https://entise.readthedocs.io>`_ for further information.
191
191
192
192
193
193
Contribution and Code Quality
194
-
=============================
194
+
==============================
195
195
Everyone is invited to develop this repository.
196
196
Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.
197
197
198
198
Coding Standards
199
-
----------------
199
+
-----------------
200
200
This repository follows consistent coding styles. Refer to `CONTRIBUTING.md <CONTRIBUTING.md>`_ for detailed standards.
201
201
202
202
Changelog
203
-
---------
203
+
----------
204
204
The changelog is maintained in the `CHANGELOG.md <CHANGELOG.md>`_ file.
205
205
It lists all changes made to the repository.
206
206
Follow instructions there to document any updates.
207
207
208
208
License and Citation
209
-
====================
209
+
=====================
210
210
|The code of this repository is licensed under the **MIT License** (MIT).
211
211
|See `LICENSE <LICENSE>`_ for rights and obligations.
212
212
|See `CITATION.cff <CITATION.cff>`_ for citation of this repository.
0 commit comments