Data

Tools

Indexes

Applications

Experiments

Open Source Science

muse_os

Welcome to the MUSE-OS repository

https://github.com/energysystemsmodellinglab/muse_os

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    8 of 22 committers (36.4%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

decarbonisation energy modelling

Keywords from Contributors

hydraulic-modelling hydrology-stormwater-analysis stormwater swmm swmm5 swmmanywhere meshing hydrology interpretability data-profilers
Last synced: 6 months ago · JSON representation ·

Repository

Welcome to the MUSE-OS repository

Basic Info
Statistics
  • Stars: 24
  • Watchers: 4
  • Forks: 9
  • Open Issues: 78
  • Releases: 25
Topics
decarbonisation energy modelling
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

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

Owner

  • Name: EnergySystemsModellingLab
  • Login: EnergySystemsModellingLab
  • Kind: organization

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.1
date-released: 2025-08-27

GitHub Events

Total
  • Create event: 173
  • Issues event: 105
  • Release event: 11
  • Watch event: 2
  • Delete event: 160
  • Issue comment event: 101
  • Push event: 915
  • Pull request review comment event: 87
  • Pull request review event: 126
  • Pull request event: 344
Last Year
  • Create event: 173
  • Issues event: 105
  • Release event: 11
  • Watch event: 2
  • Delete event: 160
  • Issue comment event: 101
  • Push event: 915
  • Pull request review comment event: 87
  • Pull request review event: 126
  • Pull request event: 344

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,239
  • Total Committers: 22
  • Avg Commits per committer: 101.773
  • Development Distribution Score (DDS): 0.749
Past Year
  • Commits: 414
  • Committers: 7
  • Avg Commits per committer: 59.143
  • Development Distribution Score (DDS): 0.097
Top Committers
Name Email Commits
Tom Bland t****d@h****k 563
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****] 33
HarmonicReflux B****f@o****m 23
Ryan Smith r****h@i****k 14
Sara s****a@S****l 14
github-actions[bot] 4****] 13
Sara s****a@S****n 13
dependabot[bot] 4****] 12
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 (Top 20 + Academic)
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

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 242
  • Total pull requests: 481
  • Average time to close issues: 4 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 15
  • Total pull request authors: 12
  • Average comments per issue: 0.94
  • Average comments per pull request: 0.85
  • Merged pull requests: 359
  • Bot issues: 0
  • Bot pull requests: 124
Past Year
  • Issues: 74
  • Pull requests: 299
  • Average time to close issues: 2 months
  • Average time to close pull requests: 6 days
  • Issue authors: 5
  • Pull request authors: 6
  • Average comments per issue: 0.49
  • Average comments per pull request: 0.32
  • Merged pull requests: 204
  • Bot issues: 0
  • Bot pull requests: 82
View more stats
Top Authors
Issue Authors
  • tsmbland (116)
  • dalonsoa (34)
  • alexdewar (25)
  • sgiarols (20)
  • ahawkes (17)
  • martinstringer (8)
  • Jin-Jun-Mei (8)
  • LennartMorlock (4)
  • HarmonicReflux (4)
  • sharwaridixit (4)
  • jamshid-yakhshilikov (2)
  • KOSHIMP (1)
  • TinyMarsh (1)
  • alexanderkell (1)
Pull Request Authors
  • tsmbland (357)
  • github-actions[bot] (81)
  • pre-commit-ci[bot] (53)
  • alexdewar (43)
  • dalonsoa (39)
  • dependabot[bot] (19)
  • sgiarols (13)
  • HarmonicReflux (8)
  • cc-a (6)
  • LennartMorlock (4)
  • AdrianDAlessandro (2)
  • martinstringer (2)
Top Labels
Issue Labels
bug (80) documentation (63) enhancement (34) infrastructure (26) question (7) wontfix (3) umbrella (3) inputs (2) on-hold (1)
Pull Request Labels
dependencies (19) github_actions (2)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 36
proxy.golang.org: github.com/energysystemsmodellinglab/muse_os
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/EnergySystemsModellingLab/MUSE_OS
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

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