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

Clarify status of FEniCSx (adapter + tutorials) #467

Closed
BenjaminRodenberg opened this issue Feb 22, 2024 · 3 comments · Fixed by #488
Closed

Clarify status of FEniCSx (adapter + tutorials) #467

BenjaminRodenberg opened this issue Feb 22, 2024 · 3 comments · Fixed by #488
Assignees
Milestone

Comments

@BenjaminRodenberg
Copy link
Member

The status of the FEniCSx adapter and the corresponding tutorials is currently unclear. This is especially relevant for the upcoming distribution release. Some risks and open questions:

  • FEniCSx latest release is version 0.7. I am not sure to which degree the API is considered stable and whether version 0.7 is compatible with the current state of the fenicsxadapter. I'm unsure which version of FEniCSx is required for the current state of the fenicsxadapter. The last working state should be related to the submission date of Philip Hildebrand's thesis.
  • There is no release of the fenicsxadapter that we can consider stable. The current state is documented in https://github.com/precice/fenicsx-adapter/milestone/1.
  • Compatibility of FEniCSx and FEniCS is unclear. Can we install both on the same system without conflicts? Related to Add FEniCSx to the vm vm#65. We definitely want to keep FEniCS at least for the upcoming distribution release. This is critical for my PhD thesis, but also reasonable looking at the number of tutorial cases, features, and experience we have for FEniCS compared to FEniCSx.

Our possibilities:

  • Don't release anything related to FEniCSx in the upcoming distribution release. Does this mean we have to put FEniCSx tutorials onto a branch, open a PR, and remove them from develop?
  • Fix issues and get to a minimal working version. Considering the points above this seems to be a major effort.
  • "Documentation-based" approach. Don't remove anything from tutorials/develop, but clearly mark FEniCSx as under construction / experimental.
@BenjaminRodenberg BenjaminRodenberg added this to the v202403.0 milestone Feb 22, 2024
@uekerman
Copy link
Member

And we would likely need a breaking FEniCSx adapter release for preCICE v3 compatibility.

@MakisH
Copy link
Member

MakisH commented Feb 28, 2024

Summary of the discussion in the telco (a bit beyond the scope of this issue):

  • Merging any tutorial means that we plan to maintain it.
  • All tutorials included in the Distribution must support preCICE v3.
  • Having a tutorial merged without a component being in the distribution is fine. In that case, we also don't install the respective code in the VM.
  • Releases of components are independent of the distribution release. The latter only helps citing and integration in the VM.

Since this tutorial has not yet been merged in main, and @BenjaminRodenberg does not have time to port it before the release, let's remove it from develop and continue in a separate branch.

@IshaanDesai
Copy link
Member

Closed via #488

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 a pull request may close this issue.

4 participants