Skip to main content

A framework for the analysis of hydrogen production cost

Project description

Documentation Status

pyH2A

pyH2A is an extensible Python framework for the analysis of hydrogen production cost. Its discounted cash flow module is based on the H2A Hydrogen Analysis model developed by the U.S. Department of Energy/NREL.

The basic discounted cash flow analysis functionality enables calculation of levelized cost of hydrogen (LCOH2). It can be interfaced with different Plugins to allow modelling of various hydrogen production technologies. Furthermore, different Analysis modules can be applied, allowing for detailed analysis of the discounted cash flow results.

It is a command line tool, with the input being provided using Markdown formatted plaintext files and the output being plots (and formatted PDF reports in the future).

Note: pyH2A is currently under development and may undergo major changes in its design.

Installation

pyH2A can be installed using pip:

pip install pyH2A

Documentation

Documentation for pyH2A is available at: https://pyh2a.readthedocs.io

Dependencies

pyH2A uses Python >=3.7 with the following libraries: NumPy, SciPy, Pandas, Matplotlib and Click

Use

pyH2A can be used from the command line:

pyH2A run -i input_file -o output_directory

For example, if the input file Input.md is in the ../Input directory and the output directory is ../Output/Example_Output:

pyH2A run -i ../Input/Input.md -o ../Output/Example_Output

Alternatively, the pyH2A class from pyH2A.run_pyH2A.py can imported and used within a Python script.

Input is provided using a plaintext Markdown file. Input files are structured by headers (designated by '#'), which are followed by Markdown style tables. Headers and tables are parsed by pyH2A.py to generate dictionaries which are used for computations. Certain input sections are mandatory (such as Technical Operating Parameters and Specifications or Financial Input Values). Additional input sections can be processed by invoking Plugins, which perform additional calculations that feed into the discounted cash flow analysis. Finally, the input file can invoke Analysis modules to analyze and visualize the output.

Example output

  • Cost breakdown

cost breakdown plot

  • Sensitivity analysis

sensitivity plot

  • Waterfall analysis

waterfall plot

  • Monte Carlo analysis, also allowing for comparison of different production pathways

colored scatter

comparative distance cost relationship and histograms

Publication data

Data for the accompanying publication can be found in the data directory.

To do

  • Importing plugins and analysis modules from arbitrary location

  • Enabling use of Default.md file in arbitrary location

  • Block diagram illustrating flow of program

  • Creation of graph showing how inputs are processed by series of plugins

  • Lifecycle analysis & net energy analysis?

License

Copyright (c) Jacob Schneidewind

All software is licensed under a MIT license (see LICENSE file).

Shield: CC BY 4.0

All other files and their contents are licensed under a Creative Commons Attribution 4.0 International License. (see LICENSE-CC-BY)

CC BY 4.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyH2A-0.0a7.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyH2A-0.0a7-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file pyH2A-0.0a7.tar.gz.

File metadata

  • Download URL: pyH2A-0.0a7.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.4

File hashes

Hashes for pyH2A-0.0a7.tar.gz
Algorithm Hash digest
SHA256 f474db5bad1904c10831b18e90e14ea32b5412fb6870240466581131c6bb0862
MD5 8975fb45655dd1ea19f05052f7be55b0
BLAKE2b-256 6f865c68ffb561719863c6640a8fa2f751dd157e45e2d8a78f019fbe83d7d4be

See more details on using hashes here.

File details

Details for the file pyH2A-0.0a7-py3-none-any.whl.

File metadata

  • Download URL: pyH2A-0.0a7-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.4

File hashes

Hashes for pyH2A-0.0a7-py3-none-any.whl
Algorithm Hash digest
SHA256 bf1dfed667e7a28fa67883a7e43225c019aff2b95f3963606a299953814688ff
MD5 ecfc0fa487ab6615fcfd5e5f0fc38378
BLAKE2b-256 41ac14358cdfc920adfae3a61f378ce261c39cdb64076bd71ffd5df22f6c18c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page