Table of Contents

1. About The Library
   • Features
2. Prerequisites
3. Basic Installation
• From GitHub
4. Usage
• As a Toolbox
• Jupyter Notebook Examples
• Using Command Line Interface (CLI)
5. Documentation
6. Contributing
7. License
8. Citing
9. Contact
10. Acknowledgments
• Institutions
• Resources
11. References
12. Contributors

About The Library

Re-Emission is a Python library and a command line interface (CLI) tool for estimating CO₂, CH₄ and N₂O emissions from reservoirs. It calculates full life-cycle emissions as well as emission profiles over time for each of the three greenhouse gases.

:fire: Features

• Calculates CO₂, CH₄ and N₂O emissions for a single reservoir and for batches of reservoirs.
• Two reservoir Phosphorus mass balance calculation methods in CO₂ emission calculations: G-Res method and McDowell method.
• Two N₂O calculation methods.
• Model parameters, and presentation of outputs are fully configurable using YAML configuration files.
• Inputs can be constructed in Python using the Input class or read from JSON files.
• Outputs in tabular form can be presented in JSON, LaTeX and PDF formats and can be configured by changing settings in the outputs.yaml configuration file.
• Integrates with the upstream catchment and reservoir delineation package GeoCARET (formerly HEET), whcih is currently in Beta version and undergoing development.
• Combines tabular and GIS inputs from catchment delineation with gas emission outputs and visualizes the combined data in interactive maps.

A quick demo of results from RE-Emission using input data from catchment delineation tool GeoCARET

Preliminary results of our first case study (for presentation use only), are shown in https://tomjanus.github.io/myaemissionsmap/. The case study looks into an assessment of gas emissions from existing and planned hydroelectric reservoirs in Myanmar. A snapshot of the map is presented below.

(back to top)

Requirements

Python Version

RE-Emission requires Python 3.10 or newer.

LaTeX Installation (Optional)

If you would like to generate output documents in a PDF format, you will need to install LaTeX. Without LaTeX, upon an attempt to compile the generated LaTeX source code to PDF, pylatex library implemented in this software will throw pylatex.errors.CompilerError. LaTeX source file with output results will still be created but it will not be able to get compiled to PostScript or PDF.

LaTeX installation guidelines can be found alonside the software installation guidelines in the documentation Documentation

Basic Installation

From GitHub

1. Clone the repository using either:
   • HTTPS sh git clone https://github.com/tomjanus/reemission.git
   • SSH sh git clone git@github.com:tomjanus/reemission.git
2. Install from source:
   • for development sh pip install -r requirements.txt -e .
   • or as a build bash pip install .

(back to top)

Usage

As a toolbox

For calculation of emissions for a number of reservoirs with input data in test_input.json file and output configuration in outputs.yaml file. ```python import pprint

Import reemission utils module

import reemission.utils as utils

Import EmissionModel class from the model module

from reemission.model import EmissionModel

Import Inputs class from the input module

from reemission.input import Inputs

Run a simple example input file from the /examples/ suite

inputdata = Inputs.fromfile(utils.getpackagefile('../../examples/simpleexample/testinput.json')) outputconfig = utils.getpackagefile('config/outputs.yaml') model = EmissionModel(inputs=inputdata, config=outputconfig) model.calculate() pprint.pprint(model.outputs) ```

Jupyter Notebook Examples

Using Command Line Interface (CLI)

RE-Emission has two CLI interfaces: reemission for performing greenhouse gas emission calculations and reemission-geocaret for processing outputs obtained from an upstream reservoir and catchment delineation tool GeoCARET (formerly HEET) and creating input files to RE-Emission. For more information about the usage, type in Terminal/Console: bash reemission --help and bash reemission-geocaret --help

For more examples, please refer to the Documentation

(back to top)

:books: Documentation

The software documentation can be accessed here

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

GPL-3.0

(back to top)

Citing

If you use RE-Emission for academic research, please cite the library using the following BibTeX entry.

@misc{reemission2022, author = {Tomasz Janus, Christopher Barry, Jaise Kuriakose}, title = {RE-Emission: Python tool for calculating greenhouse gas emissions from man-made reservoirs}, year = {2022}, url = {https://github.com/tomjanus/reemission}, }

(back to top)

:mailboxwithmail: Contact

• Tomasz Janus - tomasz.janus@manchester.ac.uk , tomasz.k.janus@gmail.com
• Christopher Barry - c.barry@ceh.ac.uk
• Jaise Kuriakose - jaise.kuriakose@manchester.ac.uk

Project Link: https://github.com/tomjanus/reemission

(back to top)

Acknowledgments

Institutions

Development of this software was funded, to a large degree, by the University of Manchester and the FutureDams project.

(back to top)

Resources

• Best README Template
• Choose an Open Source License
• Img Shields
• GitHub Pages
• Cookiecutter template for a Python library
• Cookiecutter template for a Python package

(back to top)

References

[1] Marco Aurelio dos Santos, Luiz Pinguelli Rosa, Bohdan Sikar, Elizabeth Sikar, Ednaldo Oliveira dos Santos. (2006). Gross greenhouse gas fluxes from hydro-power reservoir compared to thermo-power plants. Energy Policy, Volume 34, Issue 4, pp. 481-488, ISSN 0301-421. https://doi.org/10.1016/j.enpol.2004.06.015

[2] Beaulieu, J. J., Tank, J. L., Hamilton, S. K., Wollheim, W. M., Hall, R. O., Mulholland, P. J., Dahm, C. N. (2011). Nitrous oxide emission from denitrification in stream and river networks. Proceedings of the National Academy of Sciences of the United States of America, 108(1), 214–219. https://doi.org/10.1073/pnas.1011464108

[3] Scherer, Laura and Pfister, Stephan (2016) Hydropower's Biogenic Carbon Footprint. PLOS ONE, Volume 9, 1-11, https://doi.org/10.1371/journal.pone.0161947.

[4] Yves T. Prairie, Sara Mercier-Blais, John A. Harrison, Cynthia Soued, Paul del Giorgio, Atle Harby, Jukka Alm, Vincent Chanudet, Roy Nahas (2021) A new modelling framework to assess biogenic GHG emissions from reservoirs: The G-res tool. Environmental Modelling & Software, Volume 143, 105-117, ISSN 1364-8152, https://doi.org/10.1016/j.envsoft.2021.105117.

[5] Prairie YT, Alm J, Harby A, Mercier-Blais S, Nahas R. 2017. The GHG Reservoir Tool (G-res) Technical documentation. Updated version 3.0 (2021-10-27). UNESCO/IHA research project on the GHG status of freshwater reservoirs. Joint publication of the UNESCO Chair in Global Environmental Change and the International Hydropower Association. 73 pages.

(back to top)

Contributors ✨

Tomasz Janus 💻⚠️ 🐛🎨📖

Aung Kyaw Kyaw 💻⚠️

Chris Barry 🖋🤔📖

Jaise Kurkakose 🖋🤔📖

This project follows the all-contributors specification. Contributions of any kind welcome!

(back to top)