Modules of the oeplatform software#
This section describes the modules of the oeplatoform website software. As we use django modules are also called apps. Each modules describes a django app that provides all the backend functionality as well as the user interface for a specific area of the website.
Overview#
Each module represents a Django App and includes a specific functionality or area of the Open Energy Platform Website.
Module | Function |
---|---|
oeplatform | - Configuration of the Django application - Security-critical configuration such as connection data to a database |
base | - Basic structure for homepage and views in other components - Mainly static content for textual description of OEP and research projects - Contact form - Legal information |
api | - Provision of the RESTful API - Data management - Generic and specific data queries using query parameters - User permission querying |
login | - User management - Login system |
dataedit | - Presentation of database contents - Metadata management and annotation of ontology terms - Data management via user interface - Tag system - Data visualization - Data querying via user interface - Open Peer Review for data |
modelview | - Creation and editing of various factsheets using a developed standard format in the form of a form - Factsheet searching - Tag system |
ontology | - Integration of the Open Energy Ontology - Presentation of the contents of OEO - Descriptive contents about OEO and the development process |
oeo_viewer | - Open Energy Ontology visualization - Open Energy Ontology search functionality - Special feature: Integrated React application |
In addition to Django apps, there are other components that serve specific functionalities within the system:
Module | Explanation |
---|---|
theming | Configures the global design using Bootstrap5 and provides design components that are imported into the software components listed above. This is where the user-friendly and aesthetic presentation of the web application is configured. |
oedb_datamodels | Implements database migration schemas used for migrating changes to the database (OEDB). These schemas are utilized by an imported software tool to manage all changes to the Open Energy Database from within the Django application. |