Skip to content

Commit

Permalink
Update README to account for the chronological
Browse files Browse the repository at this point in the history
order in which the diagenetic modelling repos were created. Hopefully this clarifies the relations between those repos.
  • Loading branch information
HannoSpreeuw committed Nov 25, 2024
1 parent 426695f commit 8611075
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Integrating diagenetic equations using Python

This repo was created as an attempt to reproduce the plots shown at the kickoff of the AstroTOM ("Turing or Milankovitch") project by Niklas Hohmann, from his Matlab scripts (available at [github.com/MindTheGap-ERC/LMA-Matlab](https://github.com/MindTheGap-ERC/LMA-Matlab)).
This repo was forked off [Integrating-diagenetic-equations-using-Python](https://github.com/astro-turing/Integrating-diagenetic-equations-using-Python), which is part of the [Astro-turing organisation](https://github.com/astro-turing), created as part of the AstroToM ("Turing or Milankovitch") project, an OpenSSI 2021b project from the Netherlands eScience Center and Utrecht University (UU).

AstroTOM is an OpenSSI 2021b project from the Netherlands eScience Center and Utrecht University (UU).
The diagenetic modelling efforts within AstoToM can be regarded as a precursor to this repo and to [rhythmite](https://github.com/MindTheGap-ERC/rhythmite), while [LMA_utils](https://github.com/MindTheGap-ERC/LMA_utils), [LHeureuxEqs](https://github.com/MindTheGap-ERC/LHeureuxEqs) and [Cross-comparison](https://github.com/MindTheGap-ERC/Cross-comparison) are auxiliary repos.

Dr. Emilia Jarochowska (UU) is the lead applicant of this project.
[LMA-Matlab](https://github.com/MindTheGap-ERC/LMA-Matlab) was the first attempt to reproduce the results from [L'Heureux (2018)](https://onlinelibrary.wiley.com/doi/10.1155/2018/4968315). That repo is coded in MATLAB, while the [original diagenetic model from L'Heureux](https://github.com/astro-turing/Diagenetic_model_LHeureux_2018) was written in FORTRAN.
[Integrating-diagenetic-equations-using-Python](https://github.com/astro-turing/Integrating-diagenetic-equations-using-Python) was inspired by [LMA-Matlab](https://github.com/MindTheGap-ERC/LMA-Matlab).

After replacing central differencing for the gradients in the five diagenetic equations 40-43 from [L'Heureux (2018)](https://www.hindawi.com/journals/geofluids/2018/4968315/) by forward and backward differencing depending on the sign of U and W as a first step and a Fiadeiro-Veronis spatial difference scheme as a second step, it turns out that these equations can be integrated for more than 13.190 years (the full T*) with an implicit or explicit (in time) solver, but not with a simple Eulerian scheme. A Runge-Kutta solver, with an adaptive timestep will, however, suffice.
After correcting the value of b (5-->5e-4) it turned out that a stable integration is also possible without a Fiadeiro-Veronis scheme. The `main` branch makes use of a constant porosity diffusion coefficient.
MindTheGap is led by dr. Emilia Jarochowska (UU).

Implicit (in time) solvers with use of Jacobians (in functional forms, so without numerical approximations) are available in the `Use_solve_ivp_without_py-pde_wrapper` branch.
Wide use is made of the [py-pde](https://py-pde.readthedocs.io/en/latest/) package.

Wide use is made of the [py-pde](https://py-pde.readthedocs.io/en/latest/) package, especially in the `main` branch.
The porosity diffusion coefficient is held constant.

## Installing and using
To run this code, you need `git` and `conda` or `pip` to install .
```
git clone [email protected]:astro-turing/Integrating-diagenetic-equations-using-Python.git
git clone [email protected]:MindTheGap-ERC/reactive-transport-model-for-limestone-marl-sequences.git
```
or
```
git clone https://github.com/astro-turing/Integrating-diagenetic-equations-using-Python.git
git clone https://github.com/MindTheGap-ERC/reactive-transport-model-for-limestone-marl-sequences.git
```
Next,
```
cd Integrating-diagenetic-equations-using-Python
cd reactive-transport-model-for-limestone-marl-sequences
git switch release_v1.0.0
pipenv install
```
Expand Down

0 comments on commit 8611075

Please sign in to comment.