ImperialCollegeLondon / ImperialCollegeLondon/PyProBE

Import Experiment from README directly

Open
#343 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
56
Forks
20
PR merge metrics
No merged PRs in 30d

Description

At the moment, you need to load the actual data to be able to extract a PyBaMM Experiment object, but you can't do it from the REDME.

The goal is to add this functionality to the `readme_processor` module.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the readme_processor module and its current path for extracting a PyBaMM Experiment after data is loaded. Trace how the README is parsed and identify the existing Experiment extraction entry point. Done means the module can produce the PyBaMM Experiment directly from the README without loading the actual data.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.