Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chingyaolai authored Aug 8, 2024
1 parent 0ba6fcb commit 7b76f6a
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,11 @@ python -m pip install DIFFICE_jax
## Documentation

The documentation for the algorithms and the mathematical formulation for the data assimilation of ice shelves
are provided in the [`docs`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/docs) folder. Documentations for the **tutorial** examples and **real-data** examples are
given in the [`tutorial`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/tutorial) folder and [`examples`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/examples)
are provided in the [`docs`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/docs) folder. Documentations for the **synthetic** examples and **real-data** examples are given in the [`tutorial`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/tutorial) folder and [`examples`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/examples)
folders, respectively.

## Getting start with a Tutorial
We highly recommend the user who has no previous experience in either PINNs or inverse problems in Glaciology to get familar
with the software by reading the document and playing with the synthetic example prepared in the [`tutorial`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/tutorial) folder. The tutorial example
allow users to generate the synthetic data of velocity and thickness of an ice-shelf flow in a rectangular domain with any given
viscosity profile. Users can then use the PINNs code prepared in the folder to infer the given viscosity from the synthetic code.
We provide a [Colab Notebook](https://colab.research.google.com/github/YaoGroup/DIFFICE_jax/blob/main/tutorial/train_syndata.ipynb)
We highly recommend the user who has no previous experience in either PINNs or inverse problems in Glaciology to get familar with the software by reading the document and playing with the synthetic example prepared in the [`tutorial`](https://github.com/YaoGroup/DIFFICE_jax/tree/main/tutorial) folder. The tutorial example allow users to generate the synthetic data of velocity and thickness of an ice-shelf flow in a rectangular domain with any given viscosity profile. Users can then use the PINNs code prepared in the folder to infer the given viscosity from the synthetic code. We provide a [Colab Notebook](https://colab.research.google.com/github/YaoGroup/DIFFICE_jax/blob/main/tutorial/train_syndata.ipynb)
that allows users to compare the given viscosity with the PINN inferred viscosity to validate the accuracy of PINNs on inverse problem.


Expand Down

0 comments on commit 7b76f6a

Please sign in to comment.