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

Demo for custom classes #68

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Demo for custom classes #68

merged 2 commits into from
Jul 31, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

This fixes #59

@jhdark
Copy link
Collaborator

jhdark commented Jul 31, 2024

Just a few minor comments fom me:

  • It might be worth mentioning at the beginning that what we would like is the advection flux, showing the equation, and noting that this type of export is not currently implemented.
  • We can then note that what we want can be inherited from the SurfaceQuantity class and maybe highlight how inheritance works. Could maybe also provide a link to a tutorial on class structures? (https://www.w3schools.com/python/python_inheritance.asp)
  • can remove the comment "reinitialisation is needed". This is the first time as no T component in the velocity field
  • is it worth printing the units of the advection flux too?
  • I understand the plot of the Recomb to Surface flux is just to show that it matches, but I wonder if its worth adding axis labels here, maybe not necessary
  • do we need to add scipy to the dependencies or is that done via the festim installation?

@RemDelaporteMathurin
Copy link
Collaborator Author

@jhdark thanks, yes I didn't put too many efforts in documenting this demo. I'll add these details

@RemDelaporteMathurin
Copy link
Collaborator Author

@jhdark I added some more description. Let me know what you think

@RemDelaporteMathurin RemDelaporteMathurin merged commit 33469b4 into main Jul 31, 2024
1 check 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.

Example: How to create a custom BC, source, trap, etc
2 participants