Documentation

[finozzifa]

Closes # (if applicable).

This pull request addresses issue #65.

Changes proposed in this Pull Request

Checklist

• Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in doc.
• Data source for new technologies is clearly stated.
• Newly introduced dependencies are added to environment.yaml (if applicable).
• A note for the release notes doc/release_notes.rst of the upcoming release is included.
• I consent to the release of this PR's code under the GPLv3 license.

[euronion]

Suggestion for citing:

file content for CITATIONS.cff

# SPDX-FileCopyrightText: The technology-data authors
#
# SPDX-License-Identifier: MIT

cff-version: 1.2.0
message: "If you use this package, we suggest the following way of citing it."
title: "technology-data: Data for Energy Systems Models"
repository: https://github.com/pypsa/technology-data
version: v2-prototype # TODO: Updat automatically using a release script
license: MIT
authors:
  - family-names: Hampp
    given-names: Johannes
    orcid: 0000-0002-1776-116X
  - family-names: Finozzi
    given-names: Fabrizio
    orcid: <TODO>

Content for remaining docs can be adjusted to follow

[euronion]

Looks good!

What I'm missing is a run down on how to use everything in combination for some simple data that should be processed and an example on how to use the pre-processed DEA data.

[euronion]

Can't we directly import them everywhere like this to make it simpler and less intimidating?

Suggested change

	from technologydata.datapackage import DataPackage
	from technologydata.technology_collection import TechnologyCollection
	from technologydata.source_collection import SourceCollection
	from technologydata import DataPackage, TechnologyCollection, SourceCollection

[finozzifa]

Apologies but I do not understand. This is how the import should be done. I am not sure whether
from technologydata import DataPackage, TechnologyCollection, SourceCollection would actually work.

[euronion]

• Add content to landing page "Home"
• Update installation instructions after #80
• API reference doesn't seem to be included for me? Instead, the old API reference is still in each subpage -> preferably move this to a dedicated API section, like https://docs.pypsa.org/latest/api/networks/network/