pypsa-meets-earth/pypsa-earth

Create speed measurement infrastructure

Open

#996 opened on Mar 21, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (349 forks)auto 404
feature requestgood first issuehelp wanted

Repository metrics

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

Description

Describe the feature you'd like to see

Sometimes we make code changes and don't recognize its speed impacts.

It would be good to track for each rule (and ideally each function within the rule) the performance comparing PR branch to OS main. I saw some Python packages doing that in the past (just remembered they used Azure infra) and reading some UNIX & C wisdoms measuring that stuff is generally a good idea.

Contributor guide

Research direction
Research Python performance benchmarking libraries (e.g., pytest benchmark, asv) and how to integrate them into CI/CD pipelines (e.g., GitHub Actions) to compare PR performance against the main branch.
Tech stack
python
Domain
backendperformance
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
PythonCI/CD basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40