Scenario Bundles feature#

The scenario bundles feature is a response to the complex requirements for the transparent publication of scenarios in a complete and comprehensible manner. Various technologies are used to enable researchers to publish scenarios and any additional information. In addition, existing resources from the open energy platform are used and bundled together. This is intended to increase the visibility of available research work and enable comparability of the scenarios.

What are Scenario Bundles in detail?#

Please continue reading here.

Technologies#

User Interface

We offer a modern user interface developed with the REACT library.

Backend & Web-API

We build on the backend of the Open Energy Platform and use Django to implement functionalities such as saving and deleting scenario bundles and thus enable communication with the database. In addition, Django provides the WEB-API endpoints that are used to create a scenario bundle or query the database using JSON requests, for example.
A Python integration of the SPARQL query language is used to interact with the Grpah database.

Database

A graph database is used to store the complex data structure of the scenario bundles in the long term. We use Appache Jenna-Fuseki as a reliable technology.

Code Documentation#

Django view for the scenario bundles#

Note

Some of the information on this page may be changed in the future. To review the most recent information, please revisit.

SPDX-FileCopyrightText: 2025 Adel Memariani https://github.com/adelmemariani © Otto-von-Guericke-Universität Magdeburg SPDX-FileCopyrightText: 2025 Adel Memariani https://github.com/adelmemariani © Otto-von-Guericke-Universität Magdeburg SPDX-FileCopyrightText: 2025 Adel Memariani https://github.com/adelmemariani © Otto-von-Guericke-Universität Magdeburg SPDX-FileCopyrightText: 2025 Adel Memariani https://github.com/adelmemariani © Otto-von-Guericke-Universität Magdeburg SPDX-FileCopyrightText: 2025 Adel Memariani https://github.com/adelmemariani © Otto-von-Guericke-Universität Magdeburg SPDX-FileCopyrightText: 2025 Bryan Lancien https://github.com/bmlancien © Reiner Lemoine Institut SPDX-FileCopyrightText: 2025 Christian Winger https://github.com/wingechr © Öko-Institut e.V. SPDX-FileCopyrightText: 2025 Jonas Huber https://github.com/jh-RLI © Reiner Lemoine Institut SPDX-FileCopyrightText: 2025 Jonas Huber https://github.com/jh-RLI © Reiner Lemoine Institut SPDX-FileCopyrightText: 2025 Jonas Huber https://github.com/jh-RLI © Reiner Lemoine Institut

SPDX-License-Identifier: AGPL-3.0-or-later

`add_entities_view(request, *args, **kwargs)` #

Add entities to OEKG. The minimum requirements for adding an entity are the type and label.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`entity_type`	`str`	The type(OEO class) of the entity.	required
`entity_label`	`str`	The label of the entity.	required
`entity_iri`	`str`	The IRI of the entity.	required

Source code in factsheet/views.py

@login_required
def add_entities_view(request, *args, **kwargs):
    """
    Add entities to OEKG. The minimum requirements for
    adding an entity are the type and label.

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        entity_type (str): The type(OEO class) of the entity.
        entity_label (str): The label of the entity.
        entity_iri (str): The IRI of the entity.
    """
    request_body = json.loads(request.body)
    entity_type = request_body["entity_type"]
    entity_label = request_body["entity_label"]
    entity_iri = request_body["entity_iri"]

    vocab = entity_type.split(".")[0]
    classId = entity_type.split(".")[1]
    prefix = ""
    if vocab == "OEO":
        prefix = "https://openenergyplatform.org/ontology/oeo/"
    if vocab == "OBO":
        prefix = "http://purl.obolibrary.org/obo/"

    entity_type_URI = URIRef(prefix + classId)

    entity_URI = URIRef("https://openenergyplatform.org/ontology/oekg/" + entity_iri)

    oekg.add((entity_URI, RDF.type, entity_type_URI))
    oekg.add((entity_URI, RDFS.label, Literal(entity_label)))

    response = JsonResponse(
        "A new entity added!", safe=False, content_type="application/json"
    )
    patch_response_headers(response, cache_timeout=1)
    return response

`create_factsheet_view(request, *args, **kwargs)` #

Creates a scenario bundle based on user's data. Currently, the minimum requirement to create a bundle is the "acronym". The "acronym" must be unique. If the provided acronym already exists in the OEKG, then the function returns a "Duplicate error".

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`uid`	`str`	The unique ID for the bundle.	required
`acronym`	`str`	The acronym for the bundle.	required
`abstract`	`str`	The abstract for the bundle.	required
`institution`	`list of objects`	The institutions for the bundle.	required
`funding_source`	`list of objects`	The funding sources for the bundle.	required
`contact_person`	`list of objects`	The contact persons for the bundle.	required
`sector_divisions`	`list of objects`	The sector divisions for the bundle.	required
`sectors`	`list of objects`	The sectors for the bundle.	required
`technologies`	`list of objects`	The technologies for the bundle.	required
`study_keywords`	`list of strings`	The study keywords for the bundle.	required
`scenarios`	`list of objects`	The scenarios for the bundle.	required
`models`	`list of strings`	The models for the bundle.	required
`frameworks`	`list of strings`	The frameworks for the bundle.	required
`publications`	`list[object]`	A list of n publications related to the bundle study_name (str): The study name for the bundle. date_of_publication (str): The date of publication for the bundle. report_title (str): The report title for the bundle. report_doi (str): The report_doi for the bundle. place_of_publication (str): The place of publication for the bundle. link_to_study_report (str): The link to study for the bundle. authors (list of objects): The authors for the bundle.	required

Returns:

Type	Description
	"Factsheet saved" if successful, "Duplicate error" if the bundle's
	acronym exists.

Source code in factsheet/views.py

@require_POST
def create_factsheet_view(request, *args, **kwargs):
    """
    Creates a scenario bundle based on user's data. Currently, the minimum requirement
    to create a bundle is the "acronym". The "acronym" must be unique. If the provided
    acronym already exists in the OEKG, then the function returns a "Duplicate error".

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        uid (str): The unique ID for the bundle.
        acronym (str): The acronym for the bundle.
        abstract (str): The abstract for the bundle.
        institution (list of objects): The institutions for the bundle.
        funding_source (list of objects): The funding sources for the bundle.
        contact_person (list of objects): The contact persons for the bundle.
        sector_divisions (list of objects): The sector divisions for the bundle.
        sectors (list of objects): The sectors for the bundle.
        technologies (list of objects): The technologies for the bundle.
        study_keywords (list of strings): The study keywords for the bundle.
        scenarios (list of objects): The scenarios for the bundle.
        models (list of strings): The models for the bundle.
        frameworks (list of strings): The frameworks for the bundle.
        publications (list[object]): A list of n publications related to the bundle
            study_name (str): The study name for the bundle.
            date_of_publication (str): The date of publication for the bundle.
            report_title (str): The report title for the bundle.
            report_doi (str): The report_doi for the bundle.
            place_of_publication (str): The place of publication for the bundle.
            link_to_study_report (str): The link to study for the bundle.
            authors (list of objects): The authors for the bundle.

    Returns:
        "Factsheet saved" if successful, "Duplicate error" if the bundle's
        acronym exists.

    """

    if not request.user.is_authenticated:
        return HttpResponseForbidden("User not authenticated")

    request_body = json.loads(request.body)
    name = request_body["name"]  # noqa
    uid = request_body["uid"]
    acronym = request_body["acronym"]
    study_name = request_body["study_name"]
    abstract = request_body["abstract"]
    institution = request_body["institution"]
    funding_source = request_body["funding_source"]
    contact_person = request_body["contact_person"]
    sector_divisions = request_body["sector_divisions"]
    sectors = request_body["sectors"]
    # expanded_sectors = request_body["expanded_sectors"]  # noqa
    # energy_carriers = request_body['energy_carriers']
    # expanded_energy_carriers = request_body['expanded_energy_carriers']
    # energy_transformation_processes = request_body['energy_transformation_processes']
    # expanded_energy_transformation_processes = request_body['expanded_energy_transformation_processes'] # noqa
    technologies = request_body["technologies"]
    study_keywords = request_body["study_keywords"]
    scenarios = request_body["scenarios"]
    publications = request_body["publications"]
    models = request_body["models"]
    frameworks = request_body["frameworks"]

    Duplicate_study_factsheet = False

    for s, p, o in oekg.triples((None, RDF.type, OEO.OEO_00020227)):
        study_acronym = oekg.value(s, DC.acronym)
        if str(clean_name(acronym)) == str(study_acronym):
            Duplicate_study_factsheet = True

    if Duplicate_study_factsheet == True:  # noqa
        response = JsonResponse(
            "Factsheet exists", safe=False, content_type="application/json"
        )
        patch_response_headers(response, cache_timeout=1)
        return response
    else:
        bundle = Graph()

        study_URI = URIRef("https://openenergyplatform.org/ontology/oekg/" + uid)
        bundle.add((study_URI, RDF.type, OEO.OEO_00020227))

        if acronym != "":
            bundle.add((study_URI, DC.acronym, Literal(remove_non_printable(acronym))))
        if study_name != "":
            bundle.add(
                (
                    study_URI,
                    RDFS.label,
                    Literal(remove_non_printable(study_name)),
                )
            )
        if abstract != "":
            bundle.add(
                (study_URI, DC.abstract, Literal(remove_non_printable(abstract)))
            )

        _publications = json.loads(publications) if publications is not None else []
        for item in _publications:
            publications_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/publication/" + item["id"]
            )
            # OEO_00020012
            bundle.add((publications_URI, OEO.OEO_00390095, Literal(item["id"])))
            bundle.add((publications_URI, RDF.type, OEO.OEO_00020012))
            bundle.add((study_URI, OBO.BFO_0000051, publications_URI))
            if item["report_title"] != "":
                bundle.add(
                    (
                        publications_URI,
                        RDFS.label,
                        Literal(remove_non_printable(item["report_title"])),
                    )
                )

            _authors = item["authors"]
            for author in _authors:
                author_URI = URIRef(
                    "https://openenergyplatform.org/ontology/oekg/" + author["iri"]
                )
                bundle.add((author_URI, RDF.type, OEO.OEO_00000064))
                bundle.add((publications_URI, OEO.OEO_00000506, author_URI))

            if item["doi"] != "":
                bundle.add((publications_URI, OEO.OEO_00390098, Literal(item["doi"])))

            if (
                item["date_of_publication"] != "01-01-1900"
                and item["date_of_publication"] != ""
            ):
                bundle.add(
                    (
                        publications_URI,
                        OEO.OEO_00390096,
                        Literal(item["date_of_publication"], datatype=XSD.dateTime),
                    )
                )

            if item["link_to_study_report"] != "":
                bundle.add(
                    (URIRef(item["link_to_study_report"]), RDF.type, OEO.OEO_00000353)
                )
                bundle.add(
                    (
                        publications_URI,
                        OEO.OEO_00390078,
                        URIRef(item["link_to_study_report"]),
                    )
                )

            bundle.add((study_URI, OBO.BFO_0000051, publications_URI))

        _scenarios = json.loads(scenarios) if scenarios is not None else []
        for item in _scenarios:
            if item["acronym"] != "":
                scenario_URI = URIRef(
                    "https://openenergyplatform.org/ontology/oekg/scenario/"
                    + item["id"]
                )
                bundle.add((study_URI, OBO.BFO_0000051, scenario_URI))
                bundle.add(
                    (
                        scenario_URI,
                        DC.acronym,
                        Literal(remove_non_printable(item["acronym"])),
                    )
                )
                if item["name"] != "":
                    bundle.add(
                        (
                            scenario_URI,
                            RDFS.label,
                            Literal(remove_non_printable(item["name"])),
                        )
                    )
                    bundle.add((scenario_URI, RDF.type, OEO.OEO_00000365))
                if item["abstract"] != "":
                    bundle.add(
                        (
                            scenario_URI,
                            DC.abstract,
                            Literal(remove_non_printable(item["abstract"])),
                        )
                    )

                bundle.add((scenario_URI, OEO.OEO_00390095, Literal(item["id"])))

                if "regions" in item:
                    for region in item["regions"]:
                        region_URI = URIRef(region["iri"])
                        scenario_region = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/region/"
                            + region["iri"].rsplit("/", 1)[1]
                        )
                        bundle.add((scenario_region, RDF.type, OEO.OEO_00020032))
                        bundle.add(
                            (scenario_region, RDFS.label, Literal(region["name"]))
                        )
                        bundle.add((scenario_region, OEO.OEO_00390078, region_URI))
                        bundle.add((scenario_URI, OEO.OEO_00020220, scenario_region))

                if "interacting_regions" in item:
                    for interacting_region in item["interacting_regions"]:
                        interacting_region_URI = URIRef(interacting_region["iri"])
                        scenario_interacting_region = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/"
                            + interacting_region["iri"]
                        )

                        bundle.add(
                            (scenario_interacting_region, RDF.type, OEO.OEO_00020036)
                        )
                        bundle.add(
                            (
                                scenario_interacting_region,
                                RDFS.label,
                                Literal(interacting_region["name"]),
                            )
                        )
                        bundle.add(
                            (
                                scenario_interacting_region,
                                OEO.OEO_00390078,
                                interacting_region_URI,
                            )
                        )
                        bundle.add(
                            (
                                scenario_URI,
                                OEO.OEO_00020222,
                                scenario_interacting_region,
                            )
                        )

                if "scenario_years" in item:
                    for scenario_year in item["scenario_years"]:
                        bundle.add(
                            (
                                scenario_URI,
                                OEO.OEO_00020440,
                                Literal(scenario_year["name"], datatype=XSD.dateTime),
                            )
                        )

                if "descriptors" in item:
                    for descriptor in item["descriptors"]:
                        descriptor = URIRef(descriptor["class"])
                        bundle.add((scenario_URI, OEO.OEO_00390073, descriptor))

                # TODO: Jonas Huber: Update to avoid duplicated table name entries
                if "input_datasets" in item:
                    for input_dataset in item["input_datasets"]:
                        # TODO- set in settings
                        input_dataset_URI = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/input_datasets/"  # noqa
                            + input_dataset["key"]
                        )
                        bundle.add((input_dataset_URI, RDF.type, OEO.OEO_00030029))
                        bundle.add(
                            (
                                input_dataset_URI,
                                RDFS.label,
                                Literal(
                                    remove_non_printable(
                                        input_dataset["value"]["label"]
                                    )
                                ),
                            )
                        )
                        bundle.add(
                            (
                                input_dataset_URI,
                                OEO.OEO_00390094,
                                Literal(input_dataset["value"]["url"]),
                            )
                        )
                        bundle.add(
                            (
                                input_dataset_URI,
                                OEKG["has_id"],
                                Literal(input_dataset["idx"]),
                            )
                        )
                        bundle.add(
                            (
                                input_dataset_URI,
                                OEO.OEO_00390095,
                                Literal(input_dataset["key"]),
                            )
                        )
                        bundle.add((scenario_URI, OEO.OEO_00020437, input_dataset_URI))

                # TODO: Jonas Huber: Update to avoid duplicated table name entries
                if "output_datasets" in item:
                    for output_dataset in item["output_datasets"]:
                        output_dataset_URI = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/output_datasets/"  # noqa
                            + output_dataset["key"]
                        )
                        bundle.add((output_dataset_URI, RDF.type, OEO.OEO_00030030))
                        bundle.add(
                            (
                                output_dataset_URI,
                                RDFS.label,
                                Literal(
                                    remove_non_printable(
                                        output_dataset["value"]["label"]
                                    )
                                ),
                            )
                        )
                        bundle.add(
                            (
                                output_dataset_URI,
                                OEO.OEO_00390094,
                                Literal(output_dataset["value"]["url"]),
                            )
                        )
                        bundle.add(
                            (
                                output_dataset_URI,
                                OEKG["has_id"],
                                Literal(output_dataset["idx"]),
                            )
                        )
                        bundle.add(
                            (
                                output_dataset_URI,
                                OEO.OEO_00390095,
                                Literal(output_dataset["key"]),
                            )
                        )
                        bundle.add((scenario_URI, OEO.OEO_00020436, output_dataset_URI))

        institutions = json.loads(institution) if institution is not None else []
        for item in institutions:
            institution_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            bundle.add((study_URI, OEO.OEO_00000510, institution_URI))

        funding_sources = (
            json.loads(funding_source) if funding_source is not None else []
        )
        for item in funding_sources:
            funding_source_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            bundle.add((study_URI, OEO.OEO_00000509, funding_source_URI))
        contact_persons = (
            json.loads(contact_person) if contact_person is not None else []
        )
        for item in contact_persons:
            contact_person_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            bundle.add((study_URI, OEO.OEO_00000508, contact_person_URI))

        _sector_divisions = (
            json.loads(sector_divisions) if sector_divisions is not None else []
        )
        for item in _sector_divisions:
            sector_divisions_URI = URIRef(item["class"])
            bundle.add((study_URI, OEO.OEO_00390079, sector_divisions_URI))

        _sectors = json.loads(sectors) if sectors is not None else []
        for item in _sectors:
            sector_URI = URIRef(item["class"])
            bundle.add((study_URI, OEO.OEO_00020439, sector_URI))

        _technologies = json.loads(technologies) if technologies is not None else []
        for item in _technologies:
            technology_URI = URIRef(item["class"])
            bundle.add((study_URI, OEO.OEO_00020438, technology_URI))

        _models = json.loads(models) if models is not None else []
        for item in _models:
            model_id = item.get("id")
            if item.get("acronym"):
                model_acronym = item.get("acronym")
            else:
                model_acronym = item.get("name")
            model_url = item.get("url")

            if not model_id or not model_acronym or not model_url:
                continue  # Skip this item if any critical field is empty

            model_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/models/" + str(model_id)
            )
            bundle.add((model_URI, RDF.type, OEO.OEO_00000277))
            bundle.add(
                (
                    model_URI,
                    RDFS.label,
                    Literal(remove_non_printable(model_acronym)),
                )
            )
            bundle.add(
                (
                    model_URI,
                    OEO.OEO_00390094,
                    Literal(model_url),
                )
            )
            bundle.add((study_URI, OBO.BFO_0000051, model_URI))

        _frameworks = json.loads(frameworks) if frameworks is not None else []
        for item in _frameworks:
            framework_id = item.get("id")
            if item.get("acronym"):
                framework_acronym = item.get("acronym")
            else:
                framework_acronym = item.get("name")
            framework_url = item.get("url")

            if not framework_id or not framework_acronym or not framework_url:
                continue  # Skip this item if any critical field is empty

            framework_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/frameworks/"
                + str(framework_id)
            )

            bundle.add((framework_URI, RDF.type, OEO.OEO_00000172))

            if framework_acronym:
                bundle.add(
                    (
                        framework_URI,
                        RDFS.label,
                        Literal(remove_non_printable(framework_acronym)),
                    )
                )

            if framework_url:
                bundle.add(
                    (
                        framework_URI,
                        OEO.OEO_00390094,
                        Literal(framework_url),
                    )
                )

            bundle.add((study_URI, OBO.BFO_0000051, framework_URI))

        _study_keywords = (
            json.loads(study_keywords) if study_keywords is not None else []
        )
        # TODO:  Literal(keyword) should be URiRef
        if _study_keywords != []:
            for keyword in _study_keywords:
                bundle.add((study_URI, OEO.OEO_00390071, Literal(keyword)))

        for s, p, o in bundle.triples((None, None, None)):
            oekg.add((s, p, o))

        response = JsonResponse(
            "Factsheet saved", safe=False, content_type="application/json"
        )
        result = set_ownership(bundle_uid=uid, user=request.user)
        logger.info(result)
        patch_response_headers(response, cache_timeout=1)

        return response

`delete_factsheet_by_id_view(request, *args, **kwargs)` #

Removes a scenario bundle based on the provided ID.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`id`	`str`	The unique ID for the bundle.	required

Source code in factsheet/views.py

@only_if_user_is_owner_of_scenario_bundle
@login_required
def delete_factsheet_by_id_view(request, *args, **kwargs):
    """
    Removes a scenario bundle based on the provided ID.

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        id (str): The unique ID for the bundle.

    """
    id = request.GET.get("id")
    study_URI = URIRef("https://openenergyplatform.org/ontology/oekg/" + id)

    for s, p, o in oekg.triples((study_URI, OBO.BFO_0000051, None)):
        oekg.remove((o, None, None))
    oekg.remove((study_URI, None, None))

    response = JsonResponse(
        "factsheet removed!", safe=False, content_type="application/json"
    )
    patch_response_headers(response, cache_timeout=1)
    return response

`get_entities_by_type_view(request, *args, **kwargs)` #

Returns all entities (from OEKG) with a certain type. The type should be supplied by the user.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`entity_type`	`str`	The type(OEO class) of the entity.	required

Source code in factsheet/views.py

def get_entities_by_type_view(request, *args, **kwargs):
    """
    Returns all entities (from OEKG) with a certain type.
    The type should be supplied by the user.

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        entity_type (str): The type(OEO class) of the entity.
    """
    entity_type = request.GET.get("entity_type")
    vocab = entity_type.split(".")[0]
    classId = entity_type.split(".")[1]
    prefix = ""
    if vocab == "OEO":
        prefix = "https://openenergyplatform.org/ontology/oeo/"
    if vocab == "OBO":
        prefix = "http://purl.obolibrary.org/obo/"

    entity_URI = URIRef(prefix + classId)

    entities = []
    for s, p, o in oekg.triples((None, RDF.type, entity_URI)):
        sl = oekg.value(s, RDFS.label)
        entities.append({"name": sl, "id": sl, "iri": str(s).split("/")[-1]})

    response = JsonResponse(entities, safe=False, content_type="application/json")
    patch_response_headers(response, cache_timeout=1)
    return response

`populate_factsheets_elements_view(request, *args, **kwargs)` #

This function populates the elements required for creating or updating a factsheet. For example: Elements returned form this function populate dropdown elements which help the user to select sectors, technologies, scenario descriptors etc.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required

Returns:

Name	Type	Description
`JsonResponse`		A JSON response containing the elements for factsheet creation or update.

Source code in factsheet/views.py

def populate_factsheets_elements_view(request, *args, **kwargs):
    """
    This function populates the elements required for creating or updating a factsheet.
    For example: Elements returned form this function populate dropdown elements which
    help the user to select sectors, technologies, scenario descriptors etc.

    Args:
        request (HttpRequest): The incoming HTTP GET request.

    Returns:
        JsonResponse: A JSON response containing the elements for factsheet creation or
                    update.
    """
    scenario_class = oeo_owl.search_one(iri=OEO.OEO_00000364)
    scenario_subclasses = get_all_sub_classes(scenario_class)

    technology_class = oeo_owl.search_one(iri=OEO.OEO_00000407)
    technology_subclasses = get_all_sub_classes(technology_class)

    # energy_carrier_class = oeo_owl.search_one(iri="http://openenergy-platform.org/ontology/oeo/OEO_00020039") # noqa
    # energy_carriers = get_all_sub_classes(energy_carrier_class)

    # energy_transformation_process_class = oeo_owl.search_one(iri="http://openenergy-platform.org/ontology/oeo/OEO_00020003") # noqa
    # energy_transformation_processes = get_all_sub_classes(energy_transformation_process_class) # noqa

    sector_divisions_list, sectors_list = build_sector_dropdowns_from_oeo(oeo)
    elements = {}
    # elements['energy_carriers'] = [energy_carriers]
    # elements['energy_transformation_processes'] = [energy_transformation_processes]
    elements["sector_divisions"] = sector_divisions_list
    elements["sectors"] = sectors_list
    elements["scenario_descriptors"] = scenario_subclasses
    elements["technologies"] = technology_subclasses

    # for s, p, o in oeo.triples(( None, RDFS.subClassOf, OEO.OEO_00020003 )):
    #     sl = oeo.value(s, RDFS.label)
    #     parent = {
    #         'value': str(sl),
    #         'label': sl,
    #         'class': s
    #     }
    #     children = []
    #     for s1, p, o in oeo.triples(( None, RDFS.subClassOf, s )):
    #         sl1 = oeo.value(s1, RDFS.label)
    #         children2 = []
    #         for s2, p, o in oeo.triples(( None, RDFS.subClassOf, s1 )):
    #             sl2 = oeo.value(s2, RDFS.label)
    #             children3 = []
    #             for s3, p, o in oeo.triples(( None, RDFS.subClassOf, s2 )):
    #                 sl3 = oeo.value(s3, RDFS.label)
    #                 children3.append({
    #                     'value': str(sl) + str(sl1) + str(sl2) + str(sl3),
    #                     'label': sl3,
    #                     'class': s3
    #                 })

    #             if children3 != []:
    #                 children2.append({
    #                     'value': str(sl) + str(sl1) + str(sl2),
    #                     'label': sl2,
    #                     'class': s2,
    #                     'children': children3
    #                 })
    #             else:
    #                 children2.append({
    #                     'value': str(sl) + str(sl1) + str(sl2),
    #                     'class': s2,
    #                     'label': sl2,
    #                 })

    #         if children2 != []:
    #             children.append({
    #             'value': str(sl) + str(sl1),
    #             'label': sl1,
    #             'class': s1,
    #             'children': children2
    #             })
    #         else:
    #             children.append({
    #             'value': str(sl) + str(sl1),
    #             'class': s1,
    #             'label': sl1
    #             })

    #     if children != []:
    #         parent['children'] = children

    #     energy_transformation_processes.append(parent)

    # energy_carriers = []
    # for s, p, o in oeo.triples(( None, RDFS.subClassOf, OEO.OEO_00020039 )):
    #     sl = oeo.value(s, RDFS.label)
    #     parent = {
    #         'value': str(sl),
    #         'label': sl,
    #         'class': s
    #     }
    #     children = []
    #     for s1, p, o in oeo.triples(( None, RDFS.subClassOf, s )):
    #         sl1 = oeo.value(s1, RDFS.label)
    #         children2 = []
    #         for s2, p, o in oeo.triples(( None, RDFS.subClassOf, s1 )):
    #             sl2 = oeo.value(s2, RDFS.label)
    #             children3 = []
    #             for s3, p, o in oeo.triples(( None, RDFS.subClassOf, s2 )):
    #                 sl3 = oeo.value(s3, RDFS.label)
    #                 children3.append({
    #                     'value': str(sl) + "^^" + str(sl1) + "^^" + str(sl2) + "^^" + str(sl3), # noqa
    #                     'label': sl3,
    #                     'class': s3
    #                 })

    #             if children3 != []:
    #                 children2.append({
    #                     'value': str(sl) + "^^" + str(sl1) + "^^" + str(sl2),
    #                     'label': sl2,
    #                     'class': s2,
    #                     'children': children3
    #                 })
    #             else:
    #                 children2.append({
    #                     'value': str(sl) + "^^" + str(sl1) + "^^" + str(sl2),
    #                     'label': sl2,
    #                 })

    #         if children2 != []:
    #             children.append({
    #             'value': str(sl) + "^^" + str(sl1),
    #             'label': sl1,
    #             'class': s1,
    #             'children': children2
    #             })
    #         else:
    #             children.append({
    #             'value': str(sl) + "^^" + str(sl1),
    #             'class': s1,
    #             'label': sl1
    #             })

    #     if children != []:
    #         parent['children'] = children

    #     energy_carriers.append(parent)

    response = JsonResponse(elements, safe=False, content_type="application/json")
    patch_response_headers(response, cache_timeout=1)

    return response

`update_an_entity_view(request, *args, **kwargs)` #

Updates an entity in OEKG. The minimum requirements for updating an entity are the type, the old label, and the new label.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`entity_type`	`str`	The type(OEO class) of the entity.	required
`entity_label`	`str`	The label of the entity.	required
`new_entity_label`	`str`	The new label of the entity.	required
`entity_id`	`str`	The IRI of the entity.	required

Source code in factsheet/views.py

@login_required
def update_an_entity_view(request, *args, **kwargs):
    """
    Updates an entity in OEKG. The minimum requirements for
    updating an entity are the type, the old label, and the
    new label.

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        entity_type (str): The type(OEO class) of the entity.
        entity_label (str): The label of the entity.
        new_entity_label (str): The new label of the entity.
        entity_id (str): The IRI of the entity.
    """
    request_body = json.loads(request.body)
    entity_type = request_body["entity_type"]
    entity_label = request_body["entity_label"]
    new_entity_label = request_body["new_entity_label"]
    entity_id = request_body["entity_iri"]

    vocab = entity_type.split(".")[0]
    classId = entity_type.split(".")[1]
    prefix = ""
    if vocab == "OEO":
        prefix = "https://openenergyplatform.org/ontology/oeo/"
    if vocab == "OBO":
        prefix = "http://purl.obolibrary.org/obo/"

    entity_type_URI = URIRef(prefix + classId)  # noqa
    entity_IRI = URIRef("https://openenergyplatform.org/ontology/oekg/" + (entity_id))

    oekg.add((entity_IRI, RDFS.label, Literal(new_entity_label)))
    oekg.remove((entity_IRI, RDFS.label, Literal(entity_label)))

    response = JsonResponse(
        "entity updated!", safe=False, content_type="application/json"
    )
    patch_response_headers(response, cache_timeout=1)
    return response

`update_factsheet_view(request, *args, **kwargs)` #

Updates a scenario bundle based on user's data.

Parameters:

Name	Type	Description	Default
`request`	`HttpRequest`	The incoming HTTP GET request.	required
`uid`	`str`	The unique ID for the bundle.	required
`acronym`	`str`	The acronym for the bundle.	required
`abstract`	`str`	The abstract for the bundle.	required
`institution`	`list of objects`	The institutions for the bundle.	required
`funding_source`	`list of objects`	The funding sources for the bundle.	required
`contact_person`	`list of objects`	The contact persons for the bundle.	required
`sector_divisions`	`list of objects`	The sector divisions for the bundle.	required
`sectors`	`list of objects`	The sectors for the bundle.	required
`technologies`	`list of objects`	The technologies for the bundle.	required
`study_keywords`	`list of strings`	The study keywords for the bundle.	required
`scenarios`	`list of objects`	The scenarios for the bundle.	required
`models`	`list of strings`	The models for the bundle.	required
`frameworks`	`list of strings`	The frameworks for the bundle.	required
`publications`	`list[object]`	A list of n publications related to the bundle study_name (str): The study name for the bundle. date_of_publication (str): The date of publication for the bundle. report_title (str): The report title for the bundle. report_doi (str): The report_doi for the bundle. place_of_publication (str): The place of publication for the bundle. link_to_study_report (str): The link to study for the bundle. authors (list of objects): The authors for the bundle.	required

Source code in factsheet/views.py

@login_required
@only_if_user_is_owner_of_scenario_bundle
def update_factsheet_view(request, *args, **kwargs):
    """
    Updates a scenario bundle based on user's data.

    Args:
        request (HttpRequest): The incoming HTTP GET request.
        uid (str): The unique ID for the bundle.
        acronym (str): The acronym for the bundle.
        abstract (str): The abstract for the bundle.
        institution (list of objects): The institutions for the bundle.
        funding_source (list of objects): The funding sources for the bundle.
        contact_person (list of objects): The contact persons for the bundle.
        sector_divisions (list of objects): The sector divisions for the bundle.
        sectors (list of objects): The sectors for the bundle.
        technologies (list of objects): The technologies for the bundle.
        study_keywords (list of strings): The study keywords for the bundle.
        scenarios (list of objects): The scenarios for the bundle.
        models (list of strings): The models for the bundle.
        frameworks (list of strings): The frameworks for the bundle.
        publications (list[object]): A list of n publications related to the bundle
            study_name (str): The study name for the bundle.
            date_of_publication (str): The date of publication for the bundle.
            report_title (str): The report title for the bundle.
            report_doi (str): The report_doi for the bundle.
            place_of_publication (str): The place of publication for the bundle.
            link_to_study_report (str): The link to study for the bundle.
            authors (list of objects): The authors for the bundle.
    """
    request_body = json.loads(request.body)
    fsData = request_body["fsData"]
    # id = request_body["id"]  # noqa
    uid = request_body["uid"]
    # name = request_body["name"]  # noqa
    studyName = request_body["study_name"]
    acronym = request_body["acronym"]
    abstract = request_body["abstract"]
    institution = request_body["institution"]
    funding_source = request_body["funding_source"]
    contact_person = request_body["contact_person"]
    sector_divisions = request_body["sector_divisions"]
    sectors = request_body["sectors"]
    # expanded_sectors = request_body["expanded_sectors"]  # noqa
    # energy_carriers = request_body['energy_carriers']
    # expanded_energy_carriers = request_body['expanded_energy_carriers']
    # energy_transformation_processes = request_body['energy_transformation_processes']
    # expanded_energy_transformation_processes = request_body['expanded_energy_transformation_processes'] # noqa
    technologies = request_body["technologies"]
    study_keywords = request_body["study_keywords"]
    scenarios = request_body["scenarios"]
    models = request_body["models"]
    frameworks = request_body["frameworks"]
    publications = request_body["publications"]

    Duplicate_study_factsheet = False

    for s, p, o in oekg.triples((None, RDF.type, OEO.OEO_00020227)):
        study_acronym = oekg.value(s, DC.acronym)
        if str(clean_name(acronym)) == str(study_acronym) and str(
            clean_name(acronym)
        ) != str(fsData["acronym"]):
            Duplicate_study_factsheet = True

    if Duplicate_study_factsheet == True:  # noqa
        response = JsonResponse(
            "Factsheet exists", safe=False, content_type="application/json"
        )
        patch_response_headers(response, cache_timeout=1)
        return response

    if Duplicate_study_factsheet == False:  # noqa
        study_URI = URIRef("https://openenergyplatform.org/ontology/oekg/" + uid)

        old_bundle = Graph()
        for s, p, o in oekg.triples((study_URI, None, None)):
            old_bundle.add((s, p, o))
        for s, p, o in oekg.triples((study_URI, OBO.BFO_0000051, None)):
            for s1, p1, o1 in oekg.triples((o, None, None)):
                old_bundle.add((s1, p1, o1))

        new_bundle = Graph()
        new_bundle.add((study_URI, RDF.type, OEO.OEO_00020227))

        _publications = json.loads(publications) if publications is not None else []
        for item in _publications:
            publications_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/publication/" + item["id"]
            )

            new_bundle.add((publications_URI, OEO.OEO_00390095, Literal(item["id"])))
            new_bundle.add((publications_URI, RDF.type, OEO.OEO_00020012))
            new_bundle.add((study_URI, OBO.BFO_0000051, publications_URI))
            if item["report_title"] != "":
                new_bundle.add(
                    (publications_URI, RDFS.label, Literal(item["report_title"]))
                )

            _authors = item["authors"]

            if _authors:
                for author in _authors:
                    if author["name"]:
                        author_URI = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/"
                            + author["iri"]
                        )
                        new_bundle.add((author_URI, RDF.type, OEO.OEO_00000064))
                        new_bundle.add((publications_URI, OEO.OEO_00000506, author_URI))

            if item["doi"] != "":
                new_bundle.add(
                    (publications_URI, OEO.OEO_00390098, Literal(item["doi"]))
                )

            if (
                item["date_of_publication"] != "1900"
                and item["date_of_publication"] != ""
            ):
                new_bundle.add(
                    (
                        publications_URI,
                        OEO.OEO_00390096,
                        Literal(item["date_of_publication"], datatype=XSD.dateTime),
                    )
                )

            if item["link_to_study_report"] != "":
                new_bundle.add(
                    (URIRef(item["link_to_study_report"]), RDF.type, OEO.OEO_00000353)
                )
                new_bundle.add(
                    (
                        publications_URI,
                        OEO.OEO_00390078,
                        URIRef(item["link_to_study_report"]),
                    )
                )

            new_bundle.add((study_URI, OBO.BFO_0000051, publications_URI))

            # remove old date in publication
            # iterate to make sure it can only have unique publication date
            for _s, _p, _o in oekg.triples((publications_URI, OEO.OEO_00390096, None)):
                oekg.remove((_s, _p, _o))

        _scenarios = json.loads(scenarios) if scenarios is not None else []
        for item in _scenarios:
            if item["acronym"] != "":
                scenario_URI = URIRef(
                    "https://openenergyplatform.org/ontology/oekg/scenario/"
                    + item["id"]
                )

                for s, p, o in oekg.triples((scenario_URI, None, None)):
                    oekg.remove((o, p, o))

                new_bundle.add((scenario_URI, OEO.OEO_00390095, Literal(item["id"])))
                new_bundle.add((scenario_URI, RDF.type, OEO.OEO_00000365))
                # TODO Acronmy wird lavbel
                new_bundle.add(
                    (
                        scenario_URI,
                        DC.acronym,
                        Literal(remove_non_printable(item["acronym"])),
                    )
                )
                if item["name"] != "":
                    new_bundle.add(
                        (
                            scenario_URI,
                            RDFS.label,
                            Literal(remove_non_printable(item["name"])),
                        )
                    )
                if item["abstract"] != "" and item["abstract"] != None:  # noqa
                    new_bundle.add(
                        (
                            scenario_URI,
                            DC.abstract,
                            Literal(remove_non_printable(item["abstract"])),
                        )
                    )

                if "regions" in item:
                    for region in item["regions"]:
                        region_URI = URIRef(region["iri"])
                        scenario_region = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/region/"
                            + region["iri"].rsplit("/", 1)[1]
                        )
                        new_bundle.add((scenario_region, RDF.type, OEO.OEO_00020032))
                        new_bundle.add(
                            (
                                scenario_region,
                                RDFS.label,
                                Literal(region["name"]),
                            )
                        )
                        new_bundle.add(
                            (
                                scenario_region,
                                OEO.OEO_00390078,
                                region_URI,
                            )
                        )
                        new_bundle.add(
                            (scenario_URI, OEO.OEO_00020220, scenario_region)
                        )
                        new_bundle.add(
                            (scenario_URI, OEO.OEO_00390078, scenario_region)
                        )

                if "interacting_regions" in item:
                    for interacting_region in item["interacting_regions"]:
                        interacting_region_URI = URIRef(interacting_region["iri"])
                        scenario_interacting_region = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/"
                            + interacting_region["iri"]
                        )

                        new_bundle.add(
                            (scenario_interacting_region, RDF.type, OEO.OEO_00020036)
                        )
                        new_bundle.add(
                            (
                                scenario_interacting_region,
                                RDFS.label,
                                Literal(interacting_region["name"]),
                            )
                        )
                        new_bundle.add(
                            (
                                scenario_interacting_region,
                                OEO.OEO_00390078,
                                interacting_region_URI,
                            )
                        )

                        new_bundle.add(
                            (
                                scenario_URI,
                                OEO.OEO_00020222,
                                scenario_interacting_region,
                            )
                        )
                # TODO Value does not have datatype xsd:dateTime
                if "scenario_years" in item:
                    for scenario_year in item["scenario_years"]:
                        new_bundle.add(
                            (
                                scenario_URI,
                                OEO.OEO_00020440,
                                Literal(scenario_year["name"], datatype=XSD.dateTime),
                            )
                        )

                if "descriptors" in item:
                    for descriptor in item["descriptors"]:
                        descriptor = URIRef(descriptor["class"])
                        new_bundle.add((scenario_URI, OEO.OEO_00390073, descriptor))

                # TODO: Jonas Huber: Update to avoid duplicated table name entries
                # TODO: Predicate is not allowed (closed shape)
                if "input_datasets" in item:
                    for input_dataset in item["input_datasets"]:
                        input_dataset_URI = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/input_datasets/"  # noqa
                            + input_dataset["key"]
                        )

                        for s, p, o in oekg.triples((input_dataset_URI, None, None)):
                            oekg.remove((o, p, o))

                        new_bundle.add((input_dataset_URI, RDF.type, OEO.OEO_00030029))
                        new_bundle.add(
                            (
                                input_dataset_URI,
                                RDFS.label,
                                Literal(input_dataset["value"]["label"]),
                            )
                        )
                        new_bundle.add(
                            (
                                input_dataset_URI,
                                OEO.OEO_00390094,
                                Literal(input_dataset["value"]["url"]),
                            )
                        )
                        new_bundle.add(
                            (
                                input_dataset_URI,
                                OEKG["has_id"],
                                Literal(input_dataset["idx"]),
                            )
                        )
                        new_bundle.add(
                            (
                                input_dataset_URI,
                                OEO.OEO_00390095,
                                Literal(input_dataset["key"]),
                            )
                        )
                        new_bundle.add(
                            (scenario_URI, OEO.OEO_00020437, input_dataset_URI)
                        )

                # TODO: Jonas Huber: Update to avoid duplicated table name entries
                if "output_datasets" in item:
                    for output_dataset in item["output_datasets"]:
                        output_dataset_URI = URIRef(
                            "https://openenergyplatform.org/ontology/oekg/output_datasets/"  # noqa: E501
                            + output_dataset["key"]
                        )
                        new_bundle.add((output_dataset_URI, RDF.type, OEO.OEO_00030030))
                        new_bundle.add(
                            (
                                output_dataset_URI,
                                RDFS.label,
                                Literal(output_dataset["value"]["label"]),
                            )
                        )
                        new_bundle.add(
                            (
                                output_dataset_URI,
                                OEO.OEO_00390094,
                                Literal(output_dataset["value"]["url"]),
                            )
                        )
                        new_bundle.add(
                            (
                                output_dataset_URI,
                                OEKG["has_id"],
                                Literal(output_dataset["idx"]),
                            )
                        )
                        new_bundle.add(
                            (
                                output_dataset_URI,
                                OEO.OEO_00390095,
                                Literal(output_dataset["key"]),
                            )
                        )
                        new_bundle.add(
                            (scenario_URI, OEO.OEO_00020436, output_dataset_URI)
                        )

                new_bundle.add((study_URI, OBO.BFO_0000051, scenario_URI))

        if acronym != "":
            new_bundle.add(
                (study_URI, DC.acronym, Literal(remove_non_printable(acronym)))
            )

        new_bundle.add(
            (study_URI, RDFS.label, Literal(remove_non_printable(studyName)))
        )

        institutions = json.loads(institution) if institution is not None else []
        for item in institutions:
            institution_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            new_bundle.add((study_URI, OEO.OEO_00000510, institution_URI))

        funding_sources = (
            json.loads(funding_source) if funding_source is not None else []
        )
        for item in funding_sources:
            funding_source_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            new_bundle.add((study_URI, OEO.OEO_00000509, funding_source_URI))

        if abstract != "":
            new_bundle.add(
                (study_URI, DC.abstract, Literal(remove_non_printable(abstract)))
            )

        contact_persons = (
            json.loads(contact_person) if contact_person is not None else []
        )
        for item in contact_persons:
            contact_person_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/" + item["iri"]
            )
            new_bundle.add((study_URI, OEO.OEO_00000508, contact_person_URI))

        _sector_divisions = (
            json.loads(sector_divisions) if sector_divisions is not None else []
        )
        for item in _sector_divisions:
            sector_divisions_URI = URIRef(item["class"])
            new_bundle.add((study_URI, OEO.OEO_00390079, sector_divisions_URI))

        _sectors = json.loads(sectors) if sectors is not None else []
        for item in _sectors:
            sector_URI = URIRef(item["class"])
            new_bundle.add((study_URI, OEO.OEO_00020439, sector_URI))

        _technologies = json.loads(technologies) if technologies is not None else []
        for item in _technologies:
            technology_URI = URIRef(item["class"])
            new_bundle.add((study_URI, OEO.OEO_00020438, technology_URI))

        _models = json.loads(models) if models is not None else []
        for item in _models:
            model_id = item.get("id")

            if item.get("acronym"):
                model_acronym = item.get("acronym")
            else:
                model_acronym = item.get("name")
            model_url = item.get("url")

            if not model_id or not model_acronym or not model_url:
                continue  # Skip this item if any critical field is empty

            model_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/models/" + str(model_id)
            )
            new_bundle.add((model_URI, RDF.type, OEO.OEO_00000277))

            new_bundle.add(
                (
                    model_URI,
                    RDFS.label,
                    Literal(remove_non_printable(model_acronym)),
                )
            )

            new_bundle.add(
                (
                    model_URI,
                    OEO.OEO_00390094,
                    Literal(model_url),
                )
            )

            new_bundle.add((study_URI, OBO.BFO_0000051, model_URI))

            # remove old labels
            # iterate to make sure only current selection is available
            for _s, _p, _o in oekg.triples((model_URI, RDFS.label, None)):
                oekg.remove((_s, _p, _o))

            # remove old iri´s
            # iterate to make sure only current selection is available
            for _s, _p, _o in oekg.triples((model_URI, OEO.OEO_00390094, None)):
                oekg.remove((_s, _p, _o))

        _frameworks = json.loads(frameworks) if frameworks is not None else []
        for item in _frameworks:
            framework_id = item.get("id")
            if item.get("acronym"):
                framework_acronym = item.get("acronym")
            else:
                framework_acronym = item.get("name")
            framework_url = item.get("url")

            if not framework_id or not framework_url:
                continue  # Skip this item if any critical field is empty

            framework_URI = URIRef(
                "https://openenergyplatform.org/ontology/oekg/frameworks/"
                + str(framework_id)
            )

            new_bundle.add((framework_URI, RDF.type, OEO.OEO_00000172))
            if framework_acronym:
                new_bundle.add(
                    (
                        framework_URI,
                        RDFS.label,
                        Literal(remove_non_printable(framework_acronym)),
                    )
                )
            if framework_url:
                new_bundle.add(
                    (
                        framework_URI,
                        OEO.OEO_00390094,
                        Literal(framework_url),
                    )
                )

            new_bundle.add((study_URI, OBO.BFO_0000051, framework_URI))

            # remove old labels
            # iterate to make sure only current selection is available
            for _s, _p, _o in oekg.triples((framework_URI, RDFS.label, None)):
                oekg.remove((_s, _p, _o))

            # remove old iri´s
            # iterate to make sure only current selection is available
            for _s, _p, _o in oekg.triples((framework_URI, OEO.OEO_00390094, None)):
                oekg.remove((_s, _p, _o))

        _study_keywords = (
            json.loads(study_keywords) if study_keywords is not None else []
        )
        for keyword in _study_keywords:
            new_bundle.add((study_URI, OEO.OEO_00390071, URIRef(keyword)))

        iso_old_bundle = to_isomorphic(old_bundle)
        iso_new_bundle = to_isomorphic(new_bundle)

        in_both, in_first, in_second = graph_diff(iso_old_bundle, iso_new_bundle)

        in_first_json = str(in_first.serialize(format="json-ld"))  # noqa
        in_second_json = str(in_second.serialize(format="json-ld"))  # noqa

        # remove old bundle from oekg
        for s, p, o in oekg.triples((study_URI, OBO.BFO_0000051, None)):
            oekg.remove((o, None, None))
        oekg.remove((study_URI, None, None))

        for s, p, o in oekg.triples((study_URI, OBO.BFO_0000051, None)):
            oekg.remove((o, None, None))
        oekg.remove((study_URI, None, None))

        # add updated bundle to oekg
        for s, p, o in new_bundle.triples((None, None, None)):
            oekg.add((s, p, o))

        OEKG_Modifications_instance = OEKG_Modifications(  # noqa
            bundle_id=uid,
            user=login_models.myuser.objects.filter(name=request.user).first(),
            old_state=in_first.serialize(format="json-ld"),
            new_state=in_second.serialize(format="json-ld"),
        )
        OEKG_Modifications_instance.save()

        response = JsonResponse(
            "factsheet updated!", safe=False, content_type="application/json"
        )
        patch_response_headers(response, cache_timeout=1)
        return response

The scenario bundle object construction and API in django#

Below we describe how we construct the Scenario bundles in the scenario bundles django app. Using JSON as an input format the complex scenario bundle object becomes more manageable when working with WEB-technologies. Users will create a scenario bundle using a user interface with input text and selection fields this information is send and processed as JSON before it is stored in the OEKG using RDF´s triple notation.

You can read the following sections as: This is how django processes the data, and this is where the data is send once the user submits or changes a scenario bundles. The URL pointing out what django view will handle the JSON object below. This is very similar to what general web api´s do like REST-API´s. The exception here is that there is an CSRF Token involved which is required by the django backend to make sure requests are save and do not originate form an unsafe source allowing the scenario bundle frontend to send data to the backend.

The technology that drives this implementation is HTTP. The JSON objects and key:value information is send in packaged as a payload that is send along with each requests. A requests can be triggered by multiple actions for example a button that is pressed by the user. Based on the URL and the payload the backend can determine what functionality must be triggered. This can be for example creating a scenario bundle or retrieving a specific bundle by its ID.

Note

Some of the information on this page may be changed in the future. To review the most recent information, please revisit.

Create a new bundle in OEKG#

https://openenergy-platform.org/scenario-bundles/add/

An example of input parameters

{
  "id": "new",
  "uid": "6157d6d6-7a7b-a61e-21d3-a8f936b19056",
  "study_name": "Example study name",
  "acronym": "Example acronym",
  "abstract": "Example abstract ...",
  "institution": [
    {
      "iri": "708ad5dc-7f8b-6c65-6a5f-0fc54fe8221b",
      "name": "Öko-Institut e.V."
    },
    {
      "iri": "8e1515b9-9b1f-fa06-a3a2-d552b0ea7dcd",
      "name": "Otto-von-Guericke-Universität Magdeburg"
    }
  ],
  "funding_source": [
    {
      "iri": "82dd628d-f748-560b-b0cd-06466cf90f1a",
      "name": "Bundesministerium für Umwelt, Naturschutz und nukleare Sicherheit"
    }
  ],
  "contact_person": [],
  "sector_divisions": [],
  "sectors": [
    {
      "label": "KSG sector buildings",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010067"
    },
    {
      "label": "KSG sector industry",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010066"
    },
    {
      "label": "CRF sector (IPCC 2006): wetlands",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010192"
    },
    {
      "label": "CRF sector (IPCC 2006): other product manufacture and use",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010172"
    },
    {
      "label": "CRF sector (IPCC 2006): manure management",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010180"
    },
    {
      "label": "CRF sector (IPCC 2006): multilateral operations",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010203"
    },
    {
      "label": "CRF sector (IPCC 2006): chemical industry - other",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010353"
    }
  ],
  "technologies": [
    {
      "label": "power generation technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010423"
    },
    {
      "label": "wind power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010424"
    },
    {
      "label": "offshore wind power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010426"
    },
    {
      "label": "solar thermal power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010429"
    },
    {
      "label": "hydro power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010431"
    },
    {
      "label": "run of river power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010432"
    }
  ],
  "study_descriptors": [
    "life cycle analysis",
    "(changes in) demand",
    "degree of electrifiaction",
    "Reallabor",
    "regionalisation",
    "peak electricity generation"
  ],
  "report_title": "Example report title",
  "date_of_publication": " 2021",
  "report_doi": "5345-43-5634-6-346-46-43",
  "place_of_publication": "",
  "link_to_study": " https://openenergy-platform.org/",
  "authors": [],
  "scenarios": [
    {
      "id": "4974db65-542d-31cd-6f08-11ef9a58680a",
      "name": "Example scenario name 1 ",
      "acronym": "Example scenario acronym 1 ",
      "abstract": "Example scenario abstract 1 ... ",
      "regions": [
        {
          "name ": "Germany  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Germany "
        }
      ],
      "interacting_regions": [
        {
          "name ": "Spain  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Spain "
        }
      ],
      "scenario_years": [
        {
          "iri ": "33131404-e58e-12bc-170e-32aba1c83d99 ",
          "name ": "2021 "
        }
      ],
      "descriptors ": [
        {
          "label": "explorative scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00020248 "
        },
        {
          "label": "policy scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00020309 "
        },
        {
          "label": "climate scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00030007"
        }
      ],
      "input_datasets": [
        {
          "key": "f2d32e9c-1fa0-4d66-9ffd-c297d4bb5c9a ",
          "idx": 0,
          "value ": {
            "label ": "abbb_transmission_capacity ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transmission_capacity "
          }
        },
        {
          "key ": "ca9c82f3-9ba0-7d71-6601-dd520680bedb ",
          "idx ": 1,
          "value ": {
            "label ": "abbb_demand ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_demand "
          }
        }
      ],
      "output_datasets ": [
        {
          "key ": "0db015dd-1543-f0e9-9579-3602fb16a680 ",
          "idx ": 0,
          "value ": {
            "label ": "abbb_transformer ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transformer "
          }
        }
      ]
    },
    {
      "id ": "1f4bb594-4b1c-dca4-2465-e04a54eec10b ",
      "name ": "Example scenario name 2 ",
      "acronym ": "Example scenario acronym 2 ",
      "abstract ": "Example scenario abstract 2 ... ",
      "regions ": [
        {
          "name ": "France  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/France "
        }
      ],
      "interacting_regions ": [
        {
          "name ": "Germany  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Germany "
        }
      ],
      "scenario_years ": [],
      "descriptors ": [
        {
          "label ": "explorative scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020248 "
        },
        {
          "label ": "with additional measures scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020312 "
        },
        {
          "label ": "greenhouse gas emission scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020317 "
        },
        {
          "label ": "climate scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00030007 "
        },
        {
          "label ": "economic scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00030008 "
        }
      ],
      "input_datasets ": [
        {
          "key ": "bfc811ee-11f5-6a5a-247d-6f66bb676dd9 ",
          "idx ": 0,
          "value ": {
            "label ": "abbb_transformer ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transformer "
          }
        }
      ],
      "output_datasets ": [
        {
          "key ": "fbc30f51-7f32-9c21-dfb2-7534aeac538d ",
          "idx ": 0,
          "value ": {
            "label ": "ego_slp_parameters ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/ego_slp_parameters "
          }
        }
      ]
    }
  ],
  "models": [
    {
      "id ": "SciGrid: Open Source Reference Model of European Transmission Networks for Scientific Analysis ",
      "name ": "SciGrid: Open Source Reference Model of European Transmission Networks for Scientific Analysis "
    },
    {
      "id ": "Balmorel ",
      "name ": "Balmorel "
    },
    {
      "id ": "National Electricity Market Optimiser ",
      "name ": "National Electricity Market Optimiser "
    },
    {
      "id ": "urbs Bavaria ",
      "name ": "urbs Bavaria "
    }
  ],
  "frameworks": [
    {
      "id ": "Python for Power System Analysis toolbox (PyPSA) ",
      "name ": "Python for Power System Analysis toolbox (PyPSA) "
    },
    {
      "id ": "Framework for Integrated Energy System Assessment ",
      "name ": "Framework for Integrated Energy System Assessment "
    },
    {
      "id ": "Model Order Reduction for Gas and Energy Networks ",
      "name ": "Model Order Reduction for Gas and Energy Networks "
    },
    {
      "id ": "OMEGAlpes ",
      "name ": "OMEGAlpes "
    },
    {
      "id ": "Potsdam Integrated Assessment Modeling Framework (PIAM) ",
      "name ": "Potsdam Integrated Assessment Modeling Framework (PIAM) "
    }
  ]
}

Get a bundle in OEKG#

Retrieve a bundle by its uid

https://openenergy-platform.org/scenario-bundles/get/

An example of input parameters

{ "uid": "6157d6d6-7a7b-a61e-21d3-a8f936b19056" }

Remove a bundle from OEKG#

https://openenergy-platform.org/scenario-bundles/delete/

To delete a bundle, the uid of the bundle should be provided.

An example of input parameters

{ "uid": "6157d6d6-7a7b-a61e-21d3-a8f936b19056" }

Update a bundle in OEKG#

https://openenergy-platform.org/scenario-bundles/update/

An example of input parameters

The uid should belong to an existing bundle in OEKG. The remaining fields are identical to those in the create bundle API.

{
  "uid": "6157d6d6-7a7b-a61e-21d3-a8f936b19056",
  "study_name": "Example study name",
  "acronym": "Example acronym",
  "abstract": "Example abstract ...",
  "institution": [
    {
      "iri": "708ad5dc-7f8b-6c65-6a5f-0fc54fe8221b",
      "name": "Öko-Institut e.V."
    },
    {
      "iri": "8e1515b9-9b1f-fa06-a3a2-d552b0ea7dcd",
      "name": "Otto-von-Guericke-Universität Magdeburg"
    }
  ],
  "funding_source": [
    {
      "iri": "82dd628d-f748-560b-b0cd-06466cf90f1a",
      "name": "Bundesministerium für Umwelt, Naturschutz und nukleare Sicherheit"
    }
  ],
  "contact_person": [],
  "sector_divisions": [],
  "sectors": [
    {
      "label": "KSG sector buildings",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010067"
    },
    {
      "label": "KSG sector industry",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010066"
    },
    {
      "label": "CRF sector (IPCC 2006): wetlands",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010192"
    },
    {
      "label": "CRF sector (IPCC 2006): other product manufacture and use",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010172"
    },
    {
      "label": "CRF sector (IPCC 2006): manure management",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010180"
    },
    {
      "label": "CRF sector (IPCC 2006): multilateral operations",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010203"
    },
    {
      "label": "CRF sector (IPCC 2006): chemical industry - other",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010353"
    }
  ],
  "technologies": [
    {
      "label": "power generation technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010423"
    },
    {
      "label": "wind power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010424"
    },
    {
      "label": "offshore wind power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010426"
    },
    {
      "label": "solar thermal power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010429"
    },
    {
      "label": "hydro power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010431"
    },
    {
      "label": "run of river power technology",
      "class": "http://openenergy-platform.org/ontology/oeo/OEO_00010432"
    }
  ],
  "study_descriptors": [
    "life cycle analysis",
    "(changes in) demand",
    "degree of electrifiaction",
    "Reallabor",
    "regionalisation",
    "peak electricity generation"
  ],
  "report_title": "Example report title",
  "date_of_publication": " 2021",
  "report_doi": "5345-43-5634-6-346-46-43",
  "place_of_publication": "",
  "link_to_study": " https://openenergy-platform.org/",
  "authors": [],
  "scenarios": [
    {
      "id": "4974db65-542d-31cd-6f08-11ef9a58680a",
      "name": "Example scenario name 1 ",
      "acronym": "Example scenario acronym 1 ",
      "abstract": "Example scenario abstract 1 ... ",
      "regions": [
        {
          "name ": "Germany  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Germany "
        }
      ],
      "interacting_regions": [
        {
          "name ": "Spain  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Spain "
        }
      ],
      "scenario_years": [
        {
          "iri ": "33131404-e58e-12bc-170e-32aba1c83d99 ",
          "name ": "2021 "
        }
      ],
      "descriptors ": [
        {
          "label": "explorative scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00020248 "
        },
        {
          "label": "policy scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00020309 "
        },
        {
          "label": "climate scenario ",
          "class": "http://openenergy-platform.org/ontology/oeo/OEO_00030007"
        }
      ],
      "input_datasets": [
        {
          "key": "f2d32e9c-1fa0-4d66-9ffd-c297d4bb5c9a ",
          "idx": 0,
          "value ": {
            "label ": "abbb_transmission_capacity ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transmission_capacity "
          }
        },
        {
          "key ": "ca9c82f3-9ba0-7d71-6601-dd520680bedb ",
          "idx ": 1,
          "value ": {
            "label ": "abbb_demand ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_demand "
          }
        }
      ],
      "output_datasets ": [
        {
          "key ": "0db015dd-1543-f0e9-9579-3602fb16a680 ",
          "idx ": 0,
          "value ": {
            "label ": "abbb_transformer ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transformer "
          }
        }
      ]
    },
    {
      "id ": "1f4bb594-4b1c-dca4-2465-e04a54eec10b ",
      "name ": "Example scenario name 2 ",
      "acronym ": "Example scenario acronym 2 ",
      "abstract ": "Example scenario abstract 2 ... ",
      "regions ": [
        {
          "name ": "France  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/France "
        }
      ],
      "interacting_regions ": [
        {
          "name ": "Germany  ",
          "iri ": "https://www.omg.org/spec/LCC/Countries/ISO3166-1-CountryCodes/Germany "
        }
      ],
      "scenario_years ": [],
      "descriptors ": [
        {
          "label ": "explorative scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020248 "
        },
        {
          "label ": "with additional measures scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020312 "
        },
        {
          "label ": "greenhouse gas emission scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00020317 "
        },
        {
          "label ": "climate scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00030007 "
        },
        {
          "label ": "economic scenario ",
          "class ": "http://openenergy-platform.org/ontology/oeo/OEO_00030008 "
        }
      ],
      "input_datasets ": [
        {
          "key ": "bfc811ee-11f5-6a5a-247d-6f66bb676dd9 ",
          "idx ": 0,
          "value ": {
            "label ": "abbb_transformer ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/abbb_transformer "
          }
        }
      ],
      "output_datasets ": [
        {
          "key ": "fbc30f51-7f32-9c21-dfb2-7534aeac538d ",
          "idx ": 0,
          "value ": {
            "label ": "ego_slp_parameters ",
            "iri ": "https://openenergy-platform.org/database/tables/scenario/ego_slp_parameters "
          }
        }
      ]
    }
  ],
  "models": [
    {
      "id ": "SciGrid: Open Source Reference Model of European Transmission Networks for Scientific Analysis ",
      "name ": "SciGrid: Open Source Reference Model of European Transmission Networks for Scientific Analysis "
    },
    {
      "id ": "Balmorel ",
      "name ": "Balmorel "
    },
    {
      "id ": "National Electricity Market Optimiser ",
      "name ": "National Electricity Market Optimiser "
    },
    {
      "id ": "urbs Bavaria ",
      "name ": "urbs Bavaria "
    }
  ],
  "frameworks": [
    {
      "id ": "Python for Power System Analysis toolbox (PyPSA) ",
      "name ": "Python for Power System Analysis toolbox (PyPSA) "
    },
    {
      "id ": "Framework for Integrated Energy System Assessment ",
      "name ": "Framework for Integrated Energy System Assessment "
    },
    {
      "id ": "Model Order Reduction for Gas and Energy Networks ",
      "name ": "Model Order Reduction for Gas and Energy Networks "
    },
    {
      "id ": "OMEGAlpes ",
      "name ": "OMEGAlpes "
    },
    {
      "id ": "Potsdam Integrated Assessment Modeling Framework (PIAM) ",
      "name ": "Potsdam Integrated Assessment Modeling Framework (PIAM) "
    }
  ]
}

Scenario Bundles feature#

What are Scenario Bundles in detail?#

Technologies#

Code Documentation#

Django view for the scenario bundles#

add_entities_view(request, *args, **kwargs) #

create_factsheet_view(request, *args, **kwargs) #

delete_factsheet_by_id_view(request, *args, **kwargs) #

get_entities_by_type_view(request, *args, **kwargs) #

populate_factsheets_elements_view(request, *args, **kwargs) #

update_an_entity_view(request, *args, **kwargs) #

update_factsheet_view(request, *args, **kwargs) #

The scenario bundle object construction and API in django#

Create a new bundle in OEKG#

Get a bundle in OEKG#

Remove a bundle from OEKG#

Update a bundle in OEKG#

`add_entities_view(request, *args, **kwargs)` #

`create_factsheet_view(request, *args, **kwargs)` #

`delete_factsheet_by_id_view(request, *args, **kwargs)` #

`get_entities_by_type_view(request, *args, **kwargs)` #

`populate_factsheets_elements_view(request, *args, **kwargs)` #

`update_an_entity_view(request, *args, **kwargs)` #

`update_factsheet_view(request, *args, **kwargs)` #