Skip to content

Adds a 'State' section with lists of materials#113

Merged
martinjrobins merged 8 commits into
FaradayInstitution:mainfrom
pipliggins:4-state-params-2
Oct 13, 2025
Merged

Adds a 'State' section with lists of materials#113
martinjrobins merged 8 commits into
FaradayInstitution:mainfrom
pipliggins:4-state-params-2

Conversation

@pipliggins
Copy link
Copy Markdown
Collaborator

Fixes #4
Fixes #89

Adds a 'State' section to the schema as per BPX 1.0. All Initial conditions & Thermal state params are required, while Degradation is optional.

Parameters described in the current BPX schema as 'colon separated' are implemented as follows:

Degradation: {
  "LLI": 5
  "LAM: Positive electrode": {
     "Primary": 10,
     "Secondary": 20
     }
  "LAM: Negative electrode": 15
}

following discussions in #112.

Errors are raised directing users to the new State section where existing parameters have been moved.

I haven't made any currently optional parameters required (see #89 (comment)) as I'm not entirely clear which should be changed.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 97.53086% with 2 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@0cf060d). Learn more about missing BASE report.

Files with missing lines Patch % Lines
bpx/schema_utils.py 95.00% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #113   +/-   ##
=======================================
  Coverage        ?   96.56%           
=======================================
  Files           ?        9           
  Lines           ?      408           
  Branches        ?       37           
=======================================
  Hits            ?      394           
  Misses          ?        7           
  Partials        ?        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pipliggins
Copy link
Copy Markdown
Collaborator Author

This also adds the required parameters for #60, but doesn't implement the modification of other parameters mentioned.

@pipliggins
Copy link
Copy Markdown
Collaborator Author

Note - in the V1.0 PDF, both Initial & Ambient temperature are still listed in the Cell portion of Table 1 as well as in Table 2, I assume that's a bug.

Copy link
Copy Markdown
Collaborator

@rtimms rtimms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @pipliggins !

@ejfdickinson we will need to update the BPX spec document to reflect these changes

@rtimms rtimms mentioned this pull request Oct 6, 2025
@martinjrobins martinjrobins merged commit 22d8f3b into FaradayInstitution:main Oct 13, 2025
12 checks passed
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

Successfully merging this pull request may close these issues.

Add "Heat transfer coefficient [W.m-2.K-1]" to BPX schema "State" parameters

4 participants