BLAST-Lite icon indicating copy to clipboard operation
BLAST-Lite copied to clipboard

BLAST as a pypi package

Open calbaker opened this issue 8 months ago • 0 comments

guidelines

  • get the simplest example working first then proceed to complexity

things to make sure to do

  • [ ] pytest set up to run tests and examples
  • [x] type hinting in all functions/classes
  • [x] pyproject.toml file to make it a package
  • [x] basic and advanced functionalities implemented
  • [x] all examples in scripts and no jupyter notebooks
  • [ ] github actions to run tests whenever main branch is being changed by PR or push
  • [x] doc strings on all functions, e.g.
from typing import Optional
def some_fun(a: float, b: str, c: Optional[bool]) -> float:
    """
    Calculates battery degradation in state of health (SOH)

    # Arguments
    - a: some argument
    - b: some other arg
    - ...

    # Returns
    - amount of SOH degradation
    """

calbaker avatar Jun 10 '24 21:06 calbaker