TulipaEnergy/TulipaEnergyModel.jl

Reduce tutorial data to minimum required

Open

#1,261 opened on Jun 30, 2025

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Julia (37 forks)auto 404
good first issue

Repository metrics

Stars
 (79 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

The tutorials currently have data that is too complete, so when adding things (like a battery at the end of Tut 2) they are looking at a lot of columns. It makes more sense to give them a minimal dataset and then use populate_with_defaults!() as intended.

Validation and testing

No response

Motivation

Keep the tutorials that use Tulipa Format data in sync with the Tulipa Format.

Target audience

New users and make dev lives easier

Can you help?

Sure!

Contributor guide

Research direction
Review the tutorial data files, identify the required fields for the Tulipa Format, and see how populate with defaults!() fills in defaults. Determine the minimal dataset needed and update the tutorials accordingly.
Tech stack
None
Domain
data
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75