mVeerasingam/Battery-Simulator-Service

Option to simulate battereis at 0°/25°/75°.

Open

#4 opened on Nov 23, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (0 forks)auto 404
Active Sprintenhancementgood first issue

Repository metrics

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

Description

Flask + PyBaMM Onboarding task for Lucas.

While the priority is 'Job Manager' and 'Microservice 1' Message Queues is next in the development cycle. Onboarding and introducing Lucas to the basics of PyBaMM would be beneficial if we decide to go down alternative simulation and modelling avenues at a later date.

Task: Update the code to allow the user to choose a battery temperature in Celsius (PyBaMM records temps in kelvin)

Bonus: Batteries are typically measured in 20°/25°/75° degrees. If you can find a way to only allow the temperature input parameter to only allow one of the three mentioned degrees that would be ideal. I hope to have the website have a dropdown menu that allows only those 3 options.

Resources: Youtube (Official intro to PyBaMM): - It is also timestamped for your convivence
https://youtu.be/FA7s-Zx6O2I?feature=shared&t=1520

This is jupyter notebook example by PyBaMM on setting parameter values. 'Ambient temperature [K]' (in Kelvin) controls the temperature. https://docs.pybamm.org/en/stable/source/examples/notebooks/getting_started/tutorial-4-setting-parameter-values.html#:~:text=%27Ambient%20temperature%20%5BK%5D%27%3A%20298.15%2C

Contributor guide

Research direction
Modify the Flask endpoint to accept a temperature parameter in Celsius, convert to Kelvin, and pass it to PyBaMM simulation. For bonus, restrict input to 0, 25, 75.
Tech stack
pythonflask
Domain
backend
Issue type
Feature
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
PythonFlask
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80