Skip to content

Migrate Pourbaix workflow to pyEQL v1.5.0#369

Open
SuixiongTay wants to merge 11 commits intoKingsburyLab:mainfrom
SuixiongTay:pourbaix_pyEQL_v1.5
Open

Migrate Pourbaix workflow to pyEQL v1.5.0#369
SuixiongTay wants to merge 11 commits intoKingsburyLab:mainfrom
SuixiongTay:pourbaix_pyEQL_v1.5

Conversation

@SuixiongTay
Copy link
Copy Markdown
Collaborator

@SuixiongTay SuixiongTay commented Apr 1, 2026

Description

This PR migrates the previous pourbaix to pourbaix_pyEQL_v1.5 branch.

Content

  1. Core modules: Core pourbaix workflow and diagram construction
  • pourbaix_api.py
  • pourbaix_diagram.py
  • ion.py
  • compatibility.py
  1. Databases: Reference databases and correction schemes
  1. Tests: Test coverage from pymatgen
  • test_pourbaix_api.py
  • test_pourbaix_diagram.py

Note

  • emmet-core uses typing.NotRequired which was introduced in python 3.11.
  • Therefore, pytest.importskip is used to skip through python 3.10 to avoid the error.

Addressing #368

@SuixiongTay
Copy link
Copy Markdown
Collaborator Author

Hi @rkingsbury , I noticed the pourbaix branch is quite old and there were a lot of commits since then.

Should I target this PR against the pourbaix branch, or would you prefer this PR against the current main and let you assign the branching? Thanks!

@SuixiongTay SuixiongTay added this to the v1.5.0 milestone Apr 1, 2026
@SuixiongTay SuixiongTay changed the title Migrate Pourbaix module to pyEQL v1.5.0 Migrate Pourbaix workflow to pyEQL v1.5.0 Apr 1, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

❌ Patch coverage is 44.11303% with 712 lines in your changes missing coverage. Please review.
✅ Project coverage is 68.82%. Comparing base (804ed87) to head (e75c4ee).
⚠️ Report is 21 commits behind head on main.

Files with missing lines Patch % Lines
src/pyEQL/pourbaix/compatibility.py 16.79% 434 Missing and 2 partials ⚠️
src/pyEQL/pourbaix/pourbaix_api.py 16.02% 131 Missing ⚠️
src/pyEQL/pourbaix/ion.py 44.57% 66 Missing and 26 partials ⚠️
src/pyEQL/pourbaix/pourbaix_diagram.py 87.61% 43 Missing and 10 partials ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #369       +/-   ##
===========================================
- Coverage   86.10%   68.82%   -17.29%     
===========================================
  Files          14       18        +4     
  Lines        1821     3095     +1274     
  Branches      313      546      +233     
===========================================
+ Hits         1568     2130      +562     
- Misses        209      883      +674     
- Partials       44       82       +38     

☔ 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.

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.

1 participant