pybamm-team / pybamm-tea Goto Github PK

View Code? Open in Web Editor NEW

2.0 5.0 0.0 2.32 MB

A package for performing Techno Economic Analysis using PyBaMM

License: BSD 3-Clause "New" or "Revised" License

Python 100.00%

pybamm-tea's Issues

Structure

Think about how to structure the code. Some suggestions to get started:

A class that does the calculations for a single parameter set (the TEA class)
A class that takes a list of parameter_values, loops over them and create a TEA class for each, does the relevant calculations and plots or displays some kind of summary.
Think about API for getting economic numbers into the workflow e.g. material prices

I think a more robust test would be to create a TEA class from some known parameters and then check all the calculations are correctly compared - then you will catch if anyone accidentally changes a calculation to give the incorrect result.

Packaging

Add folders for source code, docs, and tests. Add .gitignore &pyproject.toml

For a simple example see the BPX repo
For a guide see here

Documentation

Add docs

Document calculations in TEA

Add comments for each of the calculations done in the TEA class

Dict of list instead of list of dicts to populate data frames

Doing

data = {"a": [1, 3], "b": [2, 4], "c": [3, 6]}
pd.DataFrame(data)

is equivalent to (and shorter than) doing

data = [{"a": 1, "b":2 , "c": 3}, {"a": 3, "b":5 , "c": 6}]
data = [{"a": 1, "b":2 , "c": 3}, {"a": 3, "b":5 , "c": 6}]

This can be used to clean up a bunch of code in TEA, e.g.

        stack_ed = self.stack_energy_densities
        data = [
            {
                "Parameter": "Volumetric energy density",
                "Unit": "Wh.L-1",
                "Value": stack_ed.get("Volumetric stack energy density [Wh.L-1]"),
            },
            {
                "Parameter": "Gravimetric energy density",
                "Unit": "Wh.kg-1",
                "Value": stack_ed.get("Gravimetric stack energy density [Wh.kg-1]"),
            },
            {
                "Parameter": "Stack average OCP",
                "Unit": "V",
                "Value": stack_ed.get("Stack average OCP [V]"),
            },
            {
                "Parameter": "Capacity",
                "Unit": "mA.h.cm-2",
                "Value": stack_ed.get("Capacity [mA.h.cm-2]"),
            },
            {
                "Parameter": "(Single-) stack thickness",
                "Unit": "um",
                "Value": 10**6 * stack_ed.get("Stack thickness [m]"),
            },
            {
                "Parameter": "Stack density",
                "Unit": "kg.L-1",
                "Value": 10**-3 * stack_ed.get("Stack density [kg.m-3]"),
            },
        ]
        # Create the DataFrame from the list of dictionaries
        df = pd.DataFrame(data)

could be much shorter and more readable.

Legend entries don't display properly

Raise proper warning/errors instead of print statements

Testing

Add tests and infrastructure

Set inputs in the class init

Set the inputs when you make an instance of the class instead of on the methods. This will ensure consistency across calculations.

pybamm-team / pybamm-tea Goto Github PK

pybamm-tea's Issues

README

Structure

Better testing

Packaging

Documentation

Document calculations in TEA

Dict of list instead of list of dicts to populate data frames

Legend entries don't display properly

Raise proper warning/errors instead of print statements

Testing

Set inputs in the class init

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent