Merge pull request #19 from meom-group/issue-#2

Issue #2
meom-group · Oct 27, 2023 · c0cdccc · c0cdccc
2 parents 94362b7 + a93e999
commit c0cdccc
Show file tree

Hide file tree

Showing 86 changed files with 1,195 additions and 5,244 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ build
 dist
 *.egg-info
 junit
+docs/_build
 
 # project specific
 notebooks/data/**

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ pip install jaxparrow
 ```
 
 **<ins>However</ins>**, users with access to GPUs or TPUs should first install JAX separately in order to fully benefit from its high-performance computing capacities. 
-See [JAX documentation](https://jax.readthedocs.io/en/latest/installation.html). \
+See [JAX instructions](https://jax.readthedocs.io/en/latest/installation.html). \
 By default, **jaxparrow** will install a CPU-only version of JAX if no other version is already present in the Python environment.
 
 ## Usage
@@ -48,9 +48,9 @@ u_cyclo, v_cyclo = cyclogeostrophy(u_geos=u_geos, v_geos=v_geos,
 By default, the `cyclogeostrophy` function relies on our variational method.
 Its `method` argument provides the ability to use an iterative method instead, either the one described by [Penven *et al.*](https://doi.org/10.1016/j.dsr2.2013.10.015), or the one by [Ioannou *et al.*](https://doi.org/10.1029/2019JC015031).
 Additional arguments also give a finer control over the three approaches hyperparameters. \
-See [**jaxparrow** documentation](https://meom-group.github.io/jaxparrow/) for more details.
+See **jaxparrow** [API documentation](https://meom-group.github.io/jaxparrow/api.html) for more details.
 
-[Notebooks](notebooks/README.md) are available as step-by-step examples.
+[Notebooks](notebooks) are available as step-by-step examples.
 
 ### As an executable
 

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_build/.buildinfo b/docs/_build/.buildinfo
diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle
diff --git a/docs/_build/.doctrees/index.doctree b/docs/_build/.doctrees/index.doctree
diff --git a/docs/_build/.doctrees/jaxparrow.cyclogeostrophy.doctree b/docs/_build/.doctrees/jaxparrow.cyclogeostrophy.doctree
diff --git a/docs/_build/.doctrees/jaxparrow.doctree b/docs/_build/.doctrees/jaxparrow.doctree
diff --git a/docs/_build/.doctrees/jaxparrow.geostrophy.doctree b/docs/_build/.doctrees/jaxparrow.geostrophy.doctree
diff --git a/docs/_build/.doctrees/jaxparrow.tools.doctree b/docs/_build/.doctrees/jaxparrow.tools.doctree
diff --git a/docs/_build/.doctrees/jaxparrow.tools.tools.doctree b/docs/_build/.doctrees/jaxparrow.tools.tools.doctree
diff --git a/docs/_build/.doctrees/modules.doctree b/docs/_build/.doctrees/modules.doctree
diff --git a/docs/_build/.doctrees/usage.doctree b/docs/_build/.doctrees/usage.doctree
diff --git a/docs/_build/_sources/index.rst.txt b/docs/_build/_sources/index.rst.txt
diff --git a/docs/_build/_sources/jaxparrow.cyclogeostrophy.rst.txt b/docs/_build/_sources/jaxparrow.cyclogeostrophy.rst.txt
diff --git a/docs/_build/_sources/jaxparrow.geostrophy.rst.txt b/docs/_build/_sources/jaxparrow.geostrophy.rst.txt
diff --git a/docs/_build/_sources/jaxparrow.rst.txt b/docs/_build/_sources/jaxparrow.rst.txt
diff --git a/docs/_build/_sources/jaxparrow.tools.rst.txt b/docs/_build/_sources/jaxparrow.tools.rst.txt
diff --git a/docs/_build/_sources/jaxparrow.tools.tools.rst.txt b/docs/_build/_sources/jaxparrow.tools.tools.rst.txt
diff --git a/docs/_build/_sources/usage.rst.txt b/docs/_build/_sources/usage.rst.txt