pyehub

Release 1.0.2

A library used to solve an energy hub model in Python.

Homepage PyPI

License
GPL-3.0
Install
pip install pyehub==1.0.2

Documentation

PyHub

A program to solve an energy hub model in Python.

Requirements

  • Python 3.7.3
  • pip for Python 3.7.3
  • GLPK or another solver supported by PyLP

Running a Model

To run a energy hub model, use the General_input.xlsx file to enter your data. The data must be in the same format.

Check the config.yaml file to see if the input file and output file is where you want to load and output the results of the model respectively.

While inside the config.yaml file, be sure to set the settings for using a specific solver that is installed on your system. The default one is glpk with some options, but you can set it to any other solver that is supported by PyLP.

Once you have configured the config.yaml file, run:

python run.py

to solve the model. The results should be in the file you specified in config.yaml.

Development

Installation

To install PyHub, either pip install PyEHub or download the repo and its requirements directly.

Pip installing PyEHub:

pip install pyehub

Download the repo:

git clone https://gitlab.com/energyincities/pyehub.git

Install the libraries needed for PyEHub to run:

pip install -r requirements.txt

Also install GLPK or another Pulp supporting solver. Can be found here. Windows installation instructions here

Edit the config.yaml file to use a selected solver.

Run the run.py script to see if everything works.

python run.py

Docs

Can be found here.

Contributing

Features/Bug fixes

If you are fixing a bug or making a new feature, first get the lastest master branch.

git checkout master
git pull

Then create your own branch for you to work on:

git branch <your-branch-name>
git checkout <your-branch-name>

Once you are done, please submit a pull request.

Stats

Dependencies
10
Dependent packages
1
Dependent repositories
0
Total releases
15
Latest release
First release
Stars
3
Forks
0
Contributors
0
SourceRank
9

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

1.5.0
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.2.1
1.2.0
1.1.0
1.0.5
See all 15 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-02-03 19:26:56 UTC

Login to resync this project