academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family

https://github.com/openenergyplatform/academy

Keywords

Keywords from Contributors

Repository

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family

README.rst

.. figure:: https://user-images.githubusercontent.com/14353512/244203755-9ced7f61-45e2-459c-961b-8d51653cee0e.png
    :align: left
    :target: https://openenergyplatform.github.io/academy/
    :alt: Repo logo

===================
Open Energy Academy
===================

**Training material of the Open Energy Family and the Open Energy Platform.**

.. list-table::
   :widths: auto

   * - License
     - |badge_license|
   * - Documentation
     - |badge_documentation|
   * - Publication
     -
   * - Development
     - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
   * - Community
     - |badge_contributing| |badge_contributors| |badge_repo_counts|

.. contents::
    :depth: 2
    :local:
    :backlinks: top

Introduction
============
| A collection of training courses, tutorials, and questions.
| The goal is to provide easy access to the use and development of the OEFamily.

Documentation
=============
| The documentation is created using `MkDocs `_ and the `Material Theme `_.
| All files are stored in the ``docs`` folder of the repository.
| A **GitHub Actions** deploys the ``production`` branch on a **GitHub Page**.
| The documentation page is `openenergyplatform.github.io/academy/ `_

Collaboration
=============
| Everyone is invited to develop this repository with good intentions.
| Please follow the workflow described in the `CONTRIBUTING.md `_.

License and Citation
====================
| The code of this repository is licensed under the **AGPL** (AGPL).
| See `LICENSE.txt `_ for rights and obligations.
.. | See the *Cite this repository* function or `CITATION.cff `_ for citation of this repository.
.. Copyright: `super-repo `_ © `Reiner Lemoine Institut `_ | `MIT `_


.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/academy
    :target: LICENSE.txt
    :alt: License

.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/academy/gh-pages.yml?branch=production
    :target: https://openenergyplatform.github.io/academy/
    :alt: Documentation

.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :alt: contributions

.. |badge_repo_counts| image:: http://hits.dwyl.com/OpenEnergyPlatform/academy.svg
    :alt: counter

.. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/academy
    :alt: contributors

.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/academy
    :alt: open issues

.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/academy
    :alt: closes issues

.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/academy
    :alt: closes issues

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/academy
    :alt: closes issues


Linklist for projects in the Energieforschungsprogramm
======================================================

If the tutorials change, please modify the redirects in mkdocs.yml [redirect_maps]

* Checklist for working with open data: https://openenergyplatform.github.io/academy/tutorials/other/1_checklist/
* How to generate database conform data: https://openenergyplatform.github.io/academy/tutorials/upload/data_preprocessing/7_database_data/
* How to upload data to the OEP: 2 ways!: https://openenergyplatform.github.io/academy/tutorials/upload/08_upload/
* Beginners Guidance: How to upload data to the OpenEnergy Platform and initiate the review
process: https://openenergyplatform.github.io/academy/tutorials/upload/11_beginners_guide/
* Open Data Licensing Guide: https://openenergyplatform.github.io/academy/tutorials/metadata/tutorial_open-data-licenses
* Licensing Course (FOSTER portal): https://openenergyplatform.github.io/academy/tutorials/metadata/16_licensing/

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it was below.
authors:
  - name: Hannah Förster
    alias: @han-f
    affiliation: Öko-Institut e.V
  - name: Lukas Emele
    alias: @l-emele
    affiliation: Öko-Institut e.V
  - name: Christian Hofmann
    alias: @christian-rli
    affiliation: Reiner Lemoine Institut
  - name: Jonas Huber
    alias: @jh-RLI
    affiliation: Reiner Lemoine Institut
  - name: Ludwig Hülk
    alias: "@Ludee"
    affiliation: "Öko-Institut e.V"
    orcid: https://orcid.org/0000-0003-4655-2321
  - name: Vismaya Jochem
    alias: @vismayajochem
    affiliation: Reiner Lemoine Institut
  - name: Adel Memariani
    alias: @adelmemariani
    affiliation: OvGU
  - name: Mirjam Stappel
    alias: @stap-m
    affiliation: OvGU
  - name: Christian Winger
    alias: @wingechr
    affiliation: Öko-Institut e.V
  - name: Madeleine Breitkrutz
    alias: @madbkr
    affiliation: OvGU
title: "Open Energy Academy"
license: AGPL-3.0
url: "https://github.com/OpenEnergyPlatform/academy"
citation:
  - text: "Förster et al. (2024). Open Energy Academy. https://openenergyplatform.github.io/academy"

GitHub Events

Committers

Last synced: about 2 years ago

Issues and Pull Requests

Last synced: 7 months ago