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
energy-systems-modelling hydraulic-modelling hydrology-stormwater-analysis stormwater swmm swmm5 swmmanywhere wxpython
Last synced: about 6 hours ago
JSON representation
Repository metadata
Welcome to the MUSE-OS repository
- Host: GitHub
- URL: https://github.com/EnergySystemsModellingLab/MUSE_OS
- Owner: EnergySystemsModellingLab
- License: gpl-3.0
- Created: 2022-03-10T16:55:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-27T00:22:29.000Z (2 months ago)
- Last Synced: 2025-10-27T02:31:31.855Z (2 months ago)
- Topics: decarbonisation, energy, modelling
- Language: Python
- Homepage: https://muse-os.readthedocs.io/en/latest/
- Size: 17.2 MB
- Stars: 26
- Watchers: 4
- Forks: 10
- Open Issues: 77
- Releases: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
README.md
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 defaultto run the default example model - run
muse --model default --copy XXXto copy the model to subfolderXXX. - Alternatively, run
muse settings.toml, wheresettings.tomlis an input
file for a custom model - run
muse --helpto 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.5.3
date-released: 2025-10-06
Owner metadata
- Name: EnergySystemsModellingLab
- Login: EnergySystemsModellingLab
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/11629231?v=4
- Repositories: 1
- Last ynced at: 2023-10-17T15:47:10.737Z
- Profile URL: https://github.com/EnergySystemsModellingLab
GitHub Events
Total
- Create event: 181
- Issues event: 106
- Release event: 12
- Watch event: 2
- Delete event: 165
- Issue comment event: 104
- Push event: 926
- Pull request review comment event: 87
- Pull request review event: 128
- Pull request event: 355
Last Year
- Create event: 165
- Release event: 10
- Issues event: 94
- Watch event: 2
- Delete event: 147
- Issue comment event: 93
- Push event: 829
- Pull request review comment event: 74
- Pull request review event: 112
- Pull request event: 323
Committers metadata
Last synced: 16 days ago
Total Commits: 2,260
Total Committers: 22
Avg Commits per committer: 102.727
Development Distribution Score (DDS): 0.747
Commits in past year: 238
Committers in past year: 4
Avg Commits per committer in past year: 59.5
Development Distribution Score (DDS) in past year: 0.155
| Name | Commits | |
|---|---|---|
| Tom Bland | t****d@h****k | 571 |
| 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****] | 41 |
| HarmonicReflux | B****f@o****m | 23 |
| dependabot[bot] | 4****] | 17 |
| Sara | s****a@S****l | 14 |
| Ryan Smith | r****h@i****k | 14 |
| github-actions[bot] | 4****] | 13 |
| Sara | s****a@S****n | 13 |
| Christopher Cave-Ayland | c****d@i****k | 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:
- imperial.ac.uk: 7
- kagenova.com: 1
- alexanders-air.home: 1
- saras-mbp-2.station: 1
- saras-mbp.station: 1
- kell.es: 1
- ic.ac.uk: 1
- hotmail.co.uk: 1
Issue and Pull Request metadata
Last synced: 11 days ago
Total issues: 246
Total pull requests: 646
Average time to close issues: 3 months
Average time to close pull requests: 7 days
Total issue authors: 14
Total pull request authors: 13
Average comments per issue: 0.99
Average comments per pull request: 0.91
Merged pull request: 456
Bot issues: 0
Bot pull requests: 167
Past year issues: 34
Past year pull requests: 246
Past year average time to close issues: 15 days
Past year average time to close pull requests: 5 days
Past year issue authors: 4
Past year pull request authors: 5
Past year average comments per issue: 0.29
Past year average comments per pull request: 0.24
Past year merged pull request: 156
Past year bot issues: 0
Past year bot pull requests: 79
Top Issue Authors
- tsmbland (116)
- dalonsoa (34)
- alexdewar (25)
- sgiarols (20)
- ahawkes (17)
- martinstringer (9)
- Jin-Jun-Mei (8)
- LennartMorlock (4)
- HarmonicReflux (4)
- sharwaridixit (4)
- jamshid-yakhshilikov (2)
- KOSHIMP (1)
- TinyMarsh (1)
- alexanderkell (1)
Top Pull Request Authors
- tsmbland (361)
- github-actions[bot] (85)
- pre-commit-ci[bot] (59)
- alexdewar (43)
- dalonsoa (39)
- dependabot[bot] (23)
- sgiarols (13)
- HarmonicReflux (8)
- cc-a (6)
- LennartMorlock (4)
- AdrianDAlessandro (2)
- martinstringer (2)
- jaalorsa517 (1)
Top Issue Labels
- bug (81)
- documentation (63)
- enhancement (34)
- infrastructure (26)
- question (7)
- wontfix (3)
- umbrella (3)
- inputs (2)
- on-hold (1)
Top Pull Request Labels
- dependencies (23)
- github_actions (6)
Package metadata
- Total packages: 2
- Total downloads: unknown
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 40
proxy.golang.org: github.com/energysystemsmodellinglab/muse_os
- Homepage:
- Documentation: https://pkg.go.dev/github.com/energysystemsmodellinglab/muse_os#section-documentation
- Licenses: gpl-3.0
- Latest release: v1.5.3 (published 3 months ago)
- Last Synced: 2025-12-01T12:46:39.826Z (25 days ago)
- Versions: 20
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
proxy.golang.org: github.com/EnergySystemsModellingLab/MUSE_OS
- Homepage:
- Documentation: https://pkg.go.dev/github.com/EnergySystemsModellingLab/MUSE_OS#section-documentation
- Licenses: gpl-3.0
- Latest release: v1.5.3 (published 3 months ago)
- Last Synced: 2025-12-04T00:21:17.381Z (22 days ago)
- Versions: 20
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
Dependencies
- ipykernel *
- ipython *
- myst-parser *
- nbsphinx *
- pandoc *
- pip *
- setuptools *
- sphinx >=1.4
- sphinxcontrib-bibtex *
- wheel *
- actions/checkout v2 composite
- actions/setup-python v1 composite
- pre-commit/action v2.0.2 composite
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- ammaraskar/sphinx-action master composite
- peaceiris/actions-gh-pages v3 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- browniebroke/pre-commit-autoupdate-action main composite
- peter-evans/create-pull-request v3 composite
- c-hive/gha-remove-artifacts v1 composite
- ruzickap/action-my-broken-link-checker v2 composite
- bottleneck *
- coloredlogs *
- mypy-extensions *
- numpy ==1.23.0
- pandas <=1.3
- pypubsub *
- scipy *
- toml *
- xarray ==2022.3.0
- xlrd ==1.2.0
Score: -Infinity