Grid Singularity Energy Exchange

An interface to download and deploy interconnected, grid-aware energy marketplaces.
https://github.com/gridsingularity/gsy-e

Category: Energy Systems
Sub Category: Energy Markets

Last synced: about 19 hours ago
JSON representation

Repository metadata

Grid Singularity Energy Exchange

• Host: GitHub
• URL: https://github.com/gridsingularity/gsy-e
• Owner: gridsingularity
• License: gpl-3.0
• Created: 2016-11-09T14:01:56.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-04-25T07:25:28.000Z (3 days ago)
• Last Synced: 2025-04-25T08:34:16.575Z (3 days ago)
• Language: Python
• Homepage:
• Size: 74.1 MB
• Stars: 81
• Watchers: 24
• Forks: 22
• Open Issues: 10
• Releases: 13
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

README.rst

          ====================================
Grid Singularity Energy Exchange
====================================

.. image:: https://codecov.io/gh/gridsingularity/gsy-e/branch/master/graph/badge.svg?token=XTWK3DAKUA
   :target: https://codecov.io/gh/gridsingularity/gsy-e

The Grid Singularity Energy Exchange Engine is developed by `Grid Singularity `__ as an interface (`Singularity Map `__) and open source codebase (see `Licensing `__ to model, simulate, optimize and (coming soon) download and deploy interconnected, grid-aware energy marketplaces.
Grid Singularity has been proclaimed the `World Tech Pioneer by the World Economic Forum `__ and is also known as a co-founder of the `Energy Web Foundation `__ that gathers leading energy corporations globally co-developing a shared blockchain-based platform.

Code of Conduct
===============
Please refer to: https://github.com/gridsingularity/gsy-e/blob/master/CODE_OF_CONDUCT.md

How to contribute:
==================
Please refer to: https://github.com/gridsingularity/gsy-e/blob/master/CONTRIBUTING.md


Basic setup
===========

(For instructions using `Docker`_ see below)

After cloning this project setup a Python 3.8 virtualenv and install `fabric3`_::

    ~# pip install fabric3
    
Without using virtualenv (e.g. using conda envs) you can just install gsy-e using

    ~# pip install -e .

The Simulation
==============

Running the simulation
----------------------

After installation the simulation can be run with the following command::

    ~# gsy-e run

There are various options available to control the simulation run.
Help on there is available via::

    ~# gsy-e run --help


Controlling the simulation
--------------------------

While running a simulation, the following keyboard commands are available:

=== =======
Key Command
=== =======
i   Show information about simulation
p   Pause simulation
q   Quit simulation
r   Reset and restart simulation
R   Start a Python REPL at the current simulation step
s   Save current state of simulation to file (see below for resuming)
=== =======

Development
===========

Updating requirements
---------------------

We use `pip-tools`_ managed by `fabric3`_ to handle requirements.
To update the pinned requirements use the following command::

    ~# fab compile



There is also a command to compile and sync in one step::

    ~# fab reqs


_`pip-tools`: https://github.com/nvie/pip-tools
_`fabric3`: https://pypi.python.org/pypi/Fabric3


Testing
-------

We use `py.test`_ managed by `tox`_ to run the (unit) tests.
To run the test suite simply run the following command::

    ~# tox


_`py.test`: https://pytest.org
_`tox`: https://tox.testrun.org


Docker
------

The repository contains a `docker`_ Dockerfile. To build an image use the
following command (change into repository folder first)::

    ~# docker build -t gsy-e .


After building is complete you can run the image with::

    ~# docker run --rm -it gsy-e


Command line parameters can be given normally after the image name::

    ~# docker run --rm gsy-e --help
    ~# docker run --rm gsy-e run --help
    ~# docker run --rm gsy-e run --setup default_2a -t15s


There is also a handy script that deals with the building of the image and running the provided command::

    ~# ./run_gsy_e_on_docker.sh "$docker_command" $export_path


where you can provide the gsy_e_command and export path where the simulation results are stored.
For example::

    ~# ./run_gsy_e_on_docker.sh "gsy-e -l ERROR run --setup default_2a -t 15s" $HOME/gsy_e-simulation


builds a gsy-e docker image (if not already present),
runs the simulation with setup-file default_2a, tick-length 15s
and stores the simulation output data into $HOME/gsy_e-simulation.
If no export_path is provided, simulation results will be stored in $HOME/gsy_e-simulation.


_`docker`: https://docker.io


Detailed Documentation
======================
Please refer to: https://gridsingularity.github.io/gsy-e/documentation/

        

---

Owner metadata

• Name: Grid Singularity
• Login: gridsingularity
• Email:
• Kind: organization
• Description:
• Website: https://gridsingularity.com/
• Location: Berlin
• Twitter: gridsingularity
• Company:
• Icon url: https://avatars.githubusercontent.com/u/15871858?v=4
• Repositories: 9
• Last ynced at: 2024-04-24T04:22:24.219Z
• Profile URL: https://github.com/gridsingularity

---

GitHub Events

Total

• Watch event: 4
• Delete event: 50
• Issue comment event: 44
• Push event: 129
• Pull request review event: 131
• Pull request review comment event: 106
• Pull request event: 89
• Fork event: 1
• Create event: 52
• Commit comment event: 1

Last Year

• Watch event: 4
• Delete event: 50
• Issue comment event: 44
• Push event: 129
• Pull request review event: 131
• Pull request review comment event: 106
• Pull request event: 89
• Fork event: 1
• Create event: 52
• Commit comment event: 1

---

Committers metadata

Last synced: 7 days ago

Name	Email	Commits
Spyros Tzavikas	s****s@g****m	1585
Hannes Diedrich	h****s@g****m	1413
faizan2590	f****0@g****m	1004
Hassan Hammoud	h****4@g****m	373
Pierpaolo Pantone	2****o@g****m	337
Ulrich Petri	u****o@u****e	253
Oliver Bünting	o****r@b****m	184
Jochen Müller	m****l@j****e	149
Amirhossein Saemi	a****n@g****m	125
christopher	c****2@g****m	92
ERafaelMartinez	e****l@g****m	86
Lana	s****a@g****m	69
candrews42	a****j@g****m	53
sarahhambridge	s****h@g****m	48
agatsoh	s****e@g****m	43
BigTava	b****v@g****m	32
Prakash Jha	p****a@e****m	32
[email protected]	m****a@g****m	24
kamil	k****o@g****m	20
psurender	s****r@g****m	18
Benjamin Smith	b****h@e****m	14
andreabertolini1995	a****5@g****m	11
LuisGSY	l****s@g****m	11
dirkbig	d****r@g****m	7
faizan2590	m****n@M****l	6
Christian Fleschhut	w****r@g****m	3
Fabricio	c****i@g****m	3
Maheen12	6****2	2
FeliceRocchitelli	f****e@o****l	2
georgeballes	6****s	2
and 8 more...

Committer domains:

• gridsingularity.com: 8
• enphaseenergy.com: 2
• gsys-mbp.speedport_w_921v_1_46_000: 1
• disroot.org: 1
• oida.digital: 1
• jnmr.de: 1
• brainbot.com: 1
• ulo.pe: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/gridsingularity/gsy-e

---

---

---

Dependencies

Score: 8.148445666243235