Skip to content

Added API structure to the docs #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
staudtMarius wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Added API structure to the docs #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9c7533
Added API structure to the docs
staudtMarius Nov 28, 2025
29d78f4
Merge branch 'dev' into ms/#405-api-structure-docs
staudtMarius Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- Enhanced `ExtEmDataConnection` with `simulateInternal` method [#398](https://github.com/ie3-institute/simonaAPI/issues/398)
- Added API structure to the docs [#405](https://github.com/ie3-institute/simonaAPI/issues/405)

### Changed

Expand Down
4 changes: 2 additions & 2 deletions docs/readthedocs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
author = 'Institute of Energy Systems, Energy Efficiency and Energy Economics'

# The full version, including alpha/beta/rc tags
version = '0.6.0'
release = '0.6.0'
version = '0.12.0'
release = '0.12.0'

pygments_style = 'tango'
add_function_parentheses = True
Expand Down
1 change: 1 addition & 0 deletions docs/readthedocs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ One example are external simulations, that can be used in co-simulations with SI
:maxdepth: 2

gettingstarted
structure
createextsims
extlinkinterface

Expand Down
45 changes: 45 additions & 0 deletions docs/readthedocs/structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# API Structure

This page is mend to provide an overview of the structure of this API.

The API is split into the following parts:
1. [Data](#data)
2. [Exceptions](#exceptions)
3. [Mapping](#mapping)
4. [Ontology](#ontology)
5. [Simulation](#simulation)
6. [Uncategorized](#uncategorized)

## Data

The data package and its sub-packages contains all data-related classes. These are among other things [data connections](/connections/connections),
data containers and models.


## Exceptions

This package contains some exceptions. These can be thrown by the classes of this API.


## Mapping

This package contains the `ExtEntityMapping` as well as some `DataTypes` and the `ExtEntityEntry` that are both used in
the mapping.

## Ontology

All messages that can be exchanged between SIMONA and an external simulation resp. data connection are placed in this
package.


## Simulation

The simulation package contains the available simulations. Currently, only base classes that needs to be implemented are
provided. The most important class is the [ExtSimulation](/simulations/externalsimulation) as it is the base class for
all external simulations.


## Uncategorized

There is currently only one interface that is not part of a category. This is the [ExtLinkInterface](/extlinkinterface)
that is used for loading external simulations.