Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BLAST as a pypi package #1

Open
5 of 7 tasks
calbaker opened this issue Jun 10, 2024 · 0 comments
Open
5 of 7 tasks

BLAST as a pypi package #1

calbaker opened this issue Jun 10, 2024 · 0 comments

Comments

@calbaker
Copy link

calbaker commented Jun 10, 2024

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
  • type hinting in all functions/classes
  • pyproject.toml file to make it a package
  • basic and advanced functionalities implemented
  • all examples in scripts and no jupyter notebooks
  • github actions to run tests whenever main branch is being changed by PR or push
  • 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
    """
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant