Add documentation page on example models

Open
#654 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reading the existing README in src/muse/data and the tutorials that mention default and default_timeslice. Move and tidy the example-model descriptions in the documentation so users can find them, and verify that the relevant examples are covered and the documentation builds or renders correctly.

Written by the indexing model from the issue text.

Description

documentation enhancement

There are no descriptions about the example models in the documentation (apart from some mention of default and default_timeslice in the tutorials). We have a readme file in src/muse/data with some basic descriptions, but we should tidy this up and move to the documentation so it's visible to users

Dominant language
Python
Stars
29
Forks
12
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EnergySystemsModellingLab/MUSE_OS

All issues in EnergySystemsModellingLab/MUSE_OS

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.