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

[WIP] Add field #19

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

[WIP] Add field #19

wants to merge 13 commits into from

Conversation

schmoelder
Copy link
Contributor

@schmoelder schmoelder commented Dec 2, 2024

This PR adds an new Field class which enhances current capabilities of the State.
Eventually, we need to reconsider how we integrate it into the existing framework.
For now, we use this PR to coordinate the development of external functions which will use the same structures (in Python).

Play around

Familiarize yourselves with the module:

  • Try different fields
  • Try plot methods
  • Evaluate / Interpolate

Improve testing

  • Move tests to test directory
  • Create fixtures to reuse in test cases
  • Improve coverage (use automatic metrics)

Implement use cases

(can be done outside of this repo)

  • Temperature / Adsorption
  • "Biofilm"

Missing features

  • Parametrize interpolation method (currently pchip is hard coded)

@daklauss
Copy link
Member

daklauss commented Dec 2, 2024

Seperated the tests of the field file into a seperate test_field.py file. Stillt need some rework but it should be more structured.

environment.yml Outdated Show resolved Hide resolved
@schmoelder
Copy link
Contributor Author

Merge branch 'master' of https://github.com/cadet/CADET-Python-Simulator

@cbix Call me pedantic but I loathe merge commits. Are you ok with rebasing? 😅

Btw, do you know lazygit?

@cbix
Copy link
Member

cbix commented Dec 9, 2024

Call me pedantic but I loathe merge commits. Are you ok with rebasing? 😅

@schmoelder Sure, whatever is preference in the project :) In general I'd use merge commits especially on shared branches, because the collaborators can simply pull to update, rebasing and force-push makes collaboration a bit tricky. Then squash-merging PRs but I understand that people would want to keep individual commits in history instead of squashing.

@schmoelder
Copy link
Contributor Author

@schmoelder Sure, whatever is preference in the project :) In general I'd use merge commits especially on shared branches, because the collaborators can simply pull to update, rebasing and force-push makes collaboration a bit tricky. Then squash-merging PRs but I understand that people would want to keep individual commits in history instead of squashing.

That's certainly true. Then I'd say, do whatever you want in your PR during "draft phase" but clean up before review / merging, ok?

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.

3 participants