Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MaceKuailv committed Nov 18, 2024
1 parent 8f66ef1 commit 71eacb3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions budget/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# To close budget on particles

> We are activatively tidying up the code for budget closure. The process is quite slow because the boy need to prioritize on getting his PhD :P.
The way to close tracer budget on Lagrangian particles is relatively easy. Please referred to the functions in eulerian_budget and lagrangian_budget. So far, I have not gotten the time to make an illustrative example, but the api references are ready to go.

The pdf in this directory describes, in theory, how to close budget on Lagrangian particles using seaduck. A paper will (hopefully) be published soon on this, and there will be a proper way to cite then.

The corresponding code exists, but is a lot less tidy than this package, and is therefore in a private repo. If you would like to use this functionality, please email me (Wenrui Jiang) at [email protected]. I am happy to share the code, explain things, and potentially corroborate on your project.
If you would like to use this functionality but have some difficulties, please email me (Wenrui Jiang) at [email protected]. I am happy to share my code, explain things, and potentially corroborate on your project.

If you want to contribute to the package by helping me make the budget code public, also email me. I don't know how to thank you enough.
Binary file removed budget/lagrangian_budget_theory.pdf
Binary file not shown.

0 comments on commit 71eacb3

Please sign in to comment.