TulipaEnergy/TulipaEnergyModel.jl

Add 'Why Tulipa' to the docs

Closed

#1,058 opened on Feb 27, 2025

View on GitHub
 (3 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

We should add a section to the docs. Take inspiration from DuckDB. Good that they start by saying there is no "one size fits all." I think there we can maybe comment on Tulipa being for expert modellers and researchers. Or maybe talk about different models for different types of analyses.

Validation and testing

No response

Motivation

More clarity and sort of marketing for people exploring the repo.

Target audience

New users

Can you help?

Yes

Contributor guide

Research direction
Read the DuckDB 'Why DuckDB' page for inspiration and propose a structure for the 'Why Tulipa' section, focusing on the unique value for expert modellers and researchers.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90