https://github.com/EnergySystemsModellingLab/MUSE_OS

Welcome to the MUSE-OS repository
https://github.com/EnergySystemsModellingLab/MUSE_OS

decarbonisation energy modelling

Last synced: 4 days ago
JSON representation

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 (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-29T21:06:27.000Z (12 days ago)
• Last Synced: 2025-05-03T18:05:14.516Z (8 days ago)
• Topics: decarbonisation, energy, modelling
• Language: Python
• Homepage: https://muse-os.readthedocs.io/en/latest/
• Size: 16.8 MB
• Stars: 22
• Watchers: 4
• Forks: 8
• Open Issues: 83
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

• open-sustainable-technology - MUSE_OS - A open source agent-based modelling environment that can be used to simulate change in an energy system over time. (Energy Systems / Energy System Modeling Frameworks)

README

        
[![PyPI version shields.io](https://img.shields.io/pypi/v/MUSE-OS.svg)](https://pypi.python.org/pypi/MUSE-OS/)

[![PyPI status](https://img.shields.io/pypi/status/MUSE-OS.svg)](https://pypi.python.org/pypi/MUSE-OS/)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/MUSE-OS.svg)](https://pypi.python.org/pypi/MUSE-OS/)

[![PyPI license](https://img.shields.io/pypi/l/MUSE-OS.svg)](https://pypi.python.org/pypi/MUSE-OS/)

[![QA, tests and publishing](https://github.com/EnergySystemsModellingLab/MUSE_OS/actions/workflows/ci.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE_OS/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/EnergySystemsModellingLab/MUSE_OS/graph/badge.svg?token=KJFHOHMKWK)](https://codecov.io/gh/EnergySystemsModellingLab/MUSE_OS)

# 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