MUSE_OS

A open source agent-based modelling environment that can be used to simulate change in an energy system over time.
https://github.com/EnergySystemsModellingLab/MUSE_OS

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

decarbonisation energy modelling

Keywords from Contributors

transforms measur archiving observation optimize data-profiling simulator token reporting profiles

Last synced: about 7 hours ago
JSON representation

Repository metadata

Welcome to the MUSE-OS repository

README.md

PyPI version shields.io
PyPI status
PyPI pyversions
PyPI license
QA, tests and publishing
codecov

ModUlar energy system Simulation Environment: MUSE

Installation instructions

MUSE is available in PyPI and therefore it can be installed easily with pip. Detailed instructions on how to do that ensuring the right version of Python is used can be found in the Documentation.

  • Recommended installation instructions
  • Instructions for developers

Usage

Once installed, users can:

  • activate the virtual environment (needed only once per session) as explained
    above
  • run muse --model default to run the default example model
  • run muse --model default --copy XXX to copy the model to subfolder XXX.
  • Alternatively, run muse settings.toml, where settings.toml is an input
    file for a custom model
  • run muse --help to get a description of the command-line arguments,
    including the name of any additional models provided with MUSE.

Copyright

Copyright © 2023 Imperial College London

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
    - family-names: Giarola
      given-names: Sara
    - family-names: Kell
      given-names: Alexander
    - family-names: Hawkes
      given-names: Adam

title: MUSE_OS
version: v1.4.0
date-released: 2025-4-3

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 8 days ago

Total Commits: 2,107
Total Committers: 22
Avg Commits per committer: 95.773
Development Distribution Score (DDS): 0.791

Commits in past year: 634
Committers in past year: 11
Avg Commits per committer in past year: 57.636
Development Distribution Score (DDS) in past year: 0.33

Name Email Commits
Tom Bland t****d@h****k 440
Giarola s****0@i****k 434
Diego Alonso Álvarez d****z@i****k 333
Alexander Kell a****r@k****s 307
Mayeul d'Avezac 2****c 251
Alex Dewar a****r@i****k 74
Sara s****a@S****n 66
Adrian D'Alessandro a****o@i****k 44
pre-commit-ci[bot] 6****] 26
HarmonicReflux B****f@o****m 23
Ryan Smith r****h@i****k 14
Sara s****a@S****l 14
Sara s****a@S****n 13
dependabot[bot] 4****] 12
Christopher Cave-Ayland c****d@i****k 11
github-actions[bot] 4****] 11
James Paul Turner j****r@i****k 8
Lennart Morlock 6****k 8
Dan Cummins d****7@i****k 6
Alexander Kell a****l@a****e 5
Mayeul d'Avezac m****c@k****m 4
martinstringer 1****r 3

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 299
Total pull requests: 376
Average time to close issues: 3 months
Average time to close pull requests: 7 days
Total issue authors: 15
Total pull request authors: 12
Average comments per issue: 1.07
Average comments per pull request: 1.09
Merged pull request: 294
Bot issues: 0
Bot pull requests: 85

Past year issues: 169
Past year pull requests: 280
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 6 days
Past year issue authors: 9
Past year pull request authors: 10
Past year average comments per issue: 1.16
Past year average comments per pull request: 0.96
Past year merged pull request: 207
Past year bot issues: 0
Past year bot pull requests: 60

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/EnergySystemsModellingLab/MUSE_OS

Top Issue Authors

  • tsmbland (126)
  • dalonsoa (43)
  • alexdewar (42)
  • sgiarols (24)
  • ahawkes (22)
  • martinstringer (9)
  • HarmonicReflux (9)
  • Jin-Jun-Mei (8)
  • LennartMorlock (6)
  • sharwaridixit (4)
  • jamshid-yakhshilikov (2)
  • AAQ2019 (1)
  • KOSHIMP (1)
  • TinyMarsh (1)
  • alexanderkell (1)

Top Pull Request Authors

  • tsmbland (186)
  • github-actions[bot] (50)
  • dalonsoa (38)
  • alexdewar (34)
  • pre-commit-ci[bot] (24)
  • sgiarols (15)
  • dependabot[bot] (11)
  • cc-a (6)
  • HarmonicReflux (5)
  • LennartMorlock (5)
  • AdrianDAlessandro (1)
  • martinstringer (1)

Top Issue Labels

  • bug (110)
  • documentation (89)
  • enhancement (51)
  • infrastructure (37)
  • question (7)
  • inputs (4)
  • wontfix (3)
  • umbrella (3)
  • on-hold (1)

Top Pull Request Labels

  • dependencies (11)

Dependencies

docs/requirements.txt pypi
  • ipykernel *
  • ipython *
  • myst-parser *
  • nbsphinx *
  • pandoc *
  • pip *
  • setuptools *
  • sphinx >=1.4
  • sphinxcontrib-bibtex *
  • wheel *
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • pre-commit/action v2.0.2 composite
.github/workflows/documentation.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • ammaraskar/sphinx-action master composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/pre-commit_autoupdate.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • browniebroke/pre-commit-autoupdate-action main composite
  • peter-evans/create-pull-request v3 composite
.github/workflows/remove_old_artifacts.yml actions
  • c-hive/gha-remove-artifacts v1 composite
.github/workflows/broken-link-check.yml actions
  • ruzickap/action-my-broken-link-checker v2 composite
pyproject.toml pypi
  • bottleneck *
  • coloredlogs *
  • mypy-extensions *
  • numpy ==1.23.0
  • pandas <=1.3
  • pypubsub *
  • scipy *
  • toml *
  • xarray ==2022.3.0
  • xlrd ==1.2.0

Score: 7.745002803515839