Added API structure to the docs #406
Conversation
danielfeismann
left a comment
danielfeismann
left a comment
There was a problem hiding this comment.
Thanks for improving the docs. Some comments from my side
| 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. |
There was a problem hiding this comment.
Whats the reason this is uncategorized while externalSimulation is part of Simulation?
There was a problem hiding this comment.
The external link interface is not part of any sub-directories. Since the interface is used to link the external simulation to SIMONA is doesn't fit into the simulation sub-directory.
There was a problem hiding this comment.
So, may it is an own category? I would like to avoid uncategorized. Or do you have good idea on that?
| ## 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. |
There was a problem hiding this comment.
To me this becomes not really clear. What is mend by saying, it contains the available simulations. How is this group different from e.g. data?
There was a problem hiding this comment.
Data contains the models and connections that can be used for an external simulation. If someone want to create an external simulation, a subclass of ExtSimulation is needed.
In the sub-directory simulation are currently two external simulation classes available.
There was a problem hiding this comment.
Maybe you can enhance this a bit to get this understandable for other users that aren't that deep into this?
| ## 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. |
There was a problem hiding this comment.
Should this be linked with `Data Connections``?
There was a problem hiding this comment.
Data connections is a seperat site. I linked to it, since this site is only mend to explain the API structure.
There was a problem hiding this comment.
Great, but link is broken since the myst crossref is not set properly
Resolves #405