Skip to content

PhilippVerpoort/posted

Repository files navigation

DOI

POSTED: Potsdam open-source techno-economic database

POSTED is a public database of techno-economic data on energy and climate-mitigation technologies, along with a framework for consistent data handling and an open-source toolbox for techno-economic assessments (TEA). In particular, it provides a structure for and contains data on investment cost, energy and feedstock demand, other fixed and variable costs, emissions intensities, and other characteristics of conversion, storage, and transportation technologies in the energy and related sectors. The accompanying software code is intended for consistent maintenance of this data and for deriving straight-forward results from them, such as levelised cost, greenhouse-gas emission intensities, or marginal abatement cost.

POSTED was created and is maintained by researchers at the Potsdam Institute for Climate Impact Research (PIK), a German research institute conducting integrated research for global sustainability. The source code of the accompanying framework and structure is written in both Python and R, and it is open-sourced via this git repository and may be used and redistributed under the MIT Licence. The data may be used and redistributed under the Creative Commons Licence 4.0. Any scientific work making use of POSTED (both the collected data and the software) are encouraged to cite it (DOI:10.5281/zenodo.10639752, see below).

INSTALLATION

You can install the posted Python package via:

# when using poetry
poetry add git+https://github.com/PhilippVerpoort/posted.git

# when using pip
pip install git+https://github.com/PhilippVerpoort/posted.git

You can install the posted R package using install_github from devtools via:

install_github('PhilippVerpoort/posted')

Packages on PyPI and CRAN will be made available at a later stage.

DEPENDENCY MANAGEMENT FOR TESTING AND DEVELOPMENT

Python dependencies are managed via poetry. To install dependencies in a virtual Python environment, please type the following after cloning.

poetry install

R dependencies are managed via renv and saved to the renv.lock file. To install dependencies in a virtual R environment, please type the following after cloning.

renv::restore()

CITATION

To cite POSTED, please use this:

P.C. Verpoort, P. Effing, C. Bachorz, L. Gast, L. Heidweiler, A. Hofmann, J. Dürrwächter, F. Ueckerdt (2023). POSTED: Potsdam open-source techno-economic database. Version 0.3.0, https://github.com/PhilippVerpoort/posted.

A BibTeX entry for LaTeX users is:

@Manual{,
 title = {POSTED: Potsdam open-source techno-economic database},
 author = {Philipp C. Verpoort and Paul Effing and Clara Bachorz and Lukas Gast and Leo Heidweiler and Anke Hofmann and Jakob Dürrwächter and Falko Ueckerdt},
 year = {2023},
 note = {Version 0.3.0},
 url = {https://github.com/PhilippVerpoort/posted},
}

When using data from POSTED in scientific publication, please remember that it is good scientific practice to cite both POSTED and the authors of the primary publication of the respective data entries you use. BibTeX identifiers for the source are reported in the source column in each techno-economic datafile. The respective BibTeX records can be found under inst/extdata/database/sources.bib.

LICENSE

In a nutshell -- Code: MIT, Data: CC-BY 4.0.

The source code located in subdirectories python/ and R/ of this repository is available under an MIT Licence, a copy of which is also provided as a separate file in this repository.

The data located in subdirectory inst/extdata/database/ of this repository is available under an Creative Commons Attribution 4.0 Licence, a copy of which can be found on the highlighted hyperlink.