diff --git a/.github/workflows/python-documentation.yml b/.github/workflows/python-documentation.yml new file mode 100644 index 0000000..f6d1ff7 --- /dev/null +++ b/.github/workflows/python-documentation.yml @@ -0,0 +1,33 @@ +name: Build jaxparrow html documentation + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.9" + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + sphinx-build docs docs/_build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/ + force_orphan: true diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml new file mode 100644 index 0000000..ea65926 --- /dev/null +++ b/.github/workflows/python-package.yml @@ -0,0 +1,42 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Build and test jaxparrow + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.9", "3.10", "3.11"] + + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: "pip" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install flake8 pytest + # install the package locally + python -m pip install . + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest tests/test_velocities.py --doctest-modules --junitxml=junit/test-results.xml diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml new file mode 100644 index 0000000..878ec48 --- /dev/null +++ b/.github/workflows/python-publish.yml @@ -0,0 +1,33 @@ +# This workflow will upload a Python Package using Twine when a release is created +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Upload jaxparrow to PyPI + +on: + release: + types: [published] + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.9" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/README.md b/README.md index d4c90d9..b787ca0 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ 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](docs/_build/html/index.html) for more details. +See [**jaxparrow** documentation](docs/_build/index.html) for more details. [Notebooks](notebooks/README.md) are available as step-by-step examples. diff --git a/docs/_build/html/.buildinfo b/docs/_build/.buildinfo similarity index 82% rename from docs/_build/html/.buildinfo rename to docs/_build/.buildinfo index 491b674..e319db9 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: bd118657e0721db2929ba23353b9ee53 +config: 5ec2c7199585950b86ff044830b95058 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle new file mode 100644 index 0000000..c4b11ef Binary files /dev/null and b/docs/_build/.doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/.doctrees/index.doctree similarity index 100% rename from docs/_build/doctrees/index.doctree rename to docs/_build/.doctrees/index.doctree diff --git a/docs/_build/doctrees/jaxparrow.cyclogeostrophy.doctree b/docs/_build/.doctrees/jaxparrow.cyclogeostrophy.doctree similarity index 100% rename from docs/_build/doctrees/jaxparrow.cyclogeostrophy.doctree rename to docs/_build/.doctrees/jaxparrow.cyclogeostrophy.doctree diff --git a/docs/_build/.doctrees/jaxparrow.doctree b/docs/_build/.doctrees/jaxparrow.doctree new file mode 100644 index 0000000..a926dce Binary files /dev/null and b/docs/_build/.doctrees/jaxparrow.doctree differ diff --git a/docs/_build/doctrees/jaxparrow.geostrophy.doctree b/docs/_build/.doctrees/jaxparrow.geostrophy.doctree similarity index 100% rename from docs/_build/doctrees/jaxparrow.geostrophy.doctree rename to docs/_build/.doctrees/jaxparrow.geostrophy.doctree diff --git a/docs/_build/doctrees/jaxparrow.tools.doctree b/docs/_build/.doctrees/jaxparrow.tools.doctree similarity index 100% rename from docs/_build/doctrees/jaxparrow.tools.doctree rename to docs/_build/.doctrees/jaxparrow.tools.doctree diff --git a/docs/_build/doctrees/jaxparrow.tools.tools.doctree b/docs/_build/.doctrees/jaxparrow.tools.tools.doctree similarity index 100% rename from docs/_build/doctrees/jaxparrow.tools.tools.doctree rename to docs/_build/.doctrees/jaxparrow.tools.tools.doctree diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/.doctrees/modules.doctree similarity index 100% rename from docs/_build/doctrees/modules.doctree rename to docs/_build/.doctrees/modules.doctree diff --git a/docs/_build/doctrees/usage.doctree b/docs/_build/.doctrees/usage.doctree similarity index 100% rename from docs/_build/doctrees/usage.doctree rename to docs/_build/.doctrees/usage.doctree diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/_sources/index.rst.txt similarity index 100% rename from docs/_build/html/_sources/index.rst.txt rename to docs/_build/_sources/index.rst.txt diff --git a/docs/_build/html/_sources/jaxparrow.cyclogeostrophy.rst.txt b/docs/_build/_sources/jaxparrow.cyclogeostrophy.rst.txt similarity index 100% rename from docs/_build/html/_sources/jaxparrow.cyclogeostrophy.rst.txt rename to docs/_build/_sources/jaxparrow.cyclogeostrophy.rst.txt diff --git a/docs/_build/html/_sources/jaxparrow.geostrophy.rst.txt b/docs/_build/_sources/jaxparrow.geostrophy.rst.txt similarity index 100% rename from docs/_build/html/_sources/jaxparrow.geostrophy.rst.txt rename to docs/_build/_sources/jaxparrow.geostrophy.rst.txt diff --git a/docs/_build/html/_sources/jaxparrow.rst.txt b/docs/_build/_sources/jaxparrow.rst.txt similarity index 94% rename from docs/_build/html/_sources/jaxparrow.rst.txt rename to docs/_build/_sources/jaxparrow.rst.txt index 3bb0560..45065a5 100644 --- a/docs/_build/html/_sources/jaxparrow.rst.txt +++ b/docs/_build/_sources/jaxparrow.rst.txt @@ -7,7 +7,6 @@ Subpackages .. toctree:: :maxdepth: 4 - jaxparrow.grid jaxparrow.tools Submodules diff --git a/docs/_build/html/_sources/jaxparrow.tools.rst.txt b/docs/_build/_sources/jaxparrow.tools.rst.txt similarity index 100% rename from docs/_build/html/_sources/jaxparrow.tools.rst.txt rename to docs/_build/_sources/jaxparrow.tools.rst.txt diff --git a/docs/_build/html/_sources/jaxparrow.tools.tools.rst.txt b/docs/_build/_sources/jaxparrow.tools.tools.rst.txt similarity index 100% rename from docs/_build/html/_sources/jaxparrow.tools.tools.rst.txt rename to docs/_build/_sources/jaxparrow.tools.tools.rst.txt diff --git a/docs/_build/html/_sources/modules.rst.txt b/docs/_build/_sources/modules.rst.txt similarity index 100% rename from docs/_build/html/_sources/modules.rst.txt rename to docs/_build/_sources/modules.rst.txt diff --git a/docs/_build/html/_sources/usage.rst.txt b/docs/_build/_sources/usage.rst.txt similarity index 100% rename from docs/_build/html/_sources/usage.rst.txt rename to docs/_build/_sources/usage.rst.txt diff --git a/docs/_build/html/_static/alabaster.css b/docs/_build/_static/alabaster.css similarity index 100% rename from docs/_build/html/_static/alabaster.css rename to docs/_build/_static/alabaster.css diff --git a/docs/_build/html/_static/basic.css b/docs/_build/_static/basic.css similarity index 100% rename from docs/_build/html/_static/basic.css rename to docs/_build/_static/basic.css diff --git a/docs/_build/html/_static/custom.css b/docs/_build/_static/custom.css similarity index 100% rename from docs/_build/html/_static/custom.css rename to docs/_build/_static/custom.css diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/_static/doctools.js similarity index 100% rename from docs/_build/html/_static/doctools.js rename to docs/_build/_static/doctools.js diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/_static/documentation_options.js similarity index 100% rename from docs/_build/html/_static/documentation_options.js rename to docs/_build/_static/documentation_options.js diff --git a/docs/_build/html/_static/file.png b/docs/_build/_static/file.png similarity index 100% rename from docs/_build/html/_static/file.png rename to docs/_build/_static/file.png diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/_static/language_data.js similarity index 100% rename from docs/_build/html/_static/language_data.js rename to docs/_build/_static/language_data.js diff --git a/docs/_build/html/_static/minus.png b/docs/_build/_static/minus.png similarity index 100% rename from docs/_build/html/_static/minus.png rename to docs/_build/_static/minus.png diff --git a/docs/_build/html/_static/plus.png b/docs/_build/_static/plus.png similarity index 100% rename from docs/_build/html/_static/plus.png rename to docs/_build/_static/plus.png diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/_static/pygments.css similarity index 100% rename from docs/_build/html/_static/pygments.css rename to docs/_build/_static/pygments.css diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/_static/searchtools.js similarity index 100% rename from docs/_build/html/_static/searchtools.js rename to docs/_build/_static/searchtools.js diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/_static/sphinx_highlight.js similarity index 100% rename from docs/_build/html/_static/sphinx_highlight.js rename to docs/_build/_static/sphinx_highlight.js diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 9974001..0000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/jaxparrow.doctree b/docs/_build/doctrees/jaxparrow.doctree deleted file mode 100644 index af39952..0000000 Binary files a/docs/_build/doctrees/jaxparrow.doctree and /dev/null differ diff --git a/docs/_build/doctrees/jaxparrow.grid.cgrid.doctree b/docs/_build/doctrees/jaxparrow.grid.cgrid.doctree deleted file mode 100644 index 40da9ad..0000000 Binary files a/docs/_build/doctrees/jaxparrow.grid.cgrid.doctree and /dev/null differ diff --git a/docs/_build/doctrees/jaxparrow.grid.doctree b/docs/_build/doctrees/jaxparrow.grid.doctree deleted file mode 100644 index 805ef4f..0000000 Binary files a/docs/_build/doctrees/jaxparrow.grid.doctree and /dev/null differ diff --git a/docs/_build/html/genindex.html b/docs/_build/genindex.html similarity index 57% rename from docs/_build/html/genindex.html rename to docs/_build/genindex.html index 7655afd..1bd2a2f 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/genindex.html @@ -39,36 +39,15 @@

Index

| M | N | R - | S

C

- + - @@ -164,25 +101,11 @@

J

-
  • - jaxparrow.grid - -
    • +
    -

    S

    - - - -
    - @@ -361,7 +230,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/_sources/jaxparrow.grid.cgrid.rst.txt b/docs/_build/html/_sources/jaxparrow.grid.cgrid.rst.txt deleted file mode 100644 index 213d224..0000000 --- a/docs/_build/html/_sources/jaxparrow.grid.cgrid.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -jaxparrow.grid.cgrid module -=========================== - -.. automodule:: jaxparrow.grid.cgrid - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/jaxparrow.grid.rst.txt b/docs/_build/html/_sources/jaxparrow.grid.rst.txt deleted file mode 100644 index b955432..0000000 --- a/docs/_build/html/_sources/jaxparrow.grid.rst.txt +++ /dev/null @@ -1,18 +0,0 @@ -jaxparrow.grid package -====================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - jaxparrow.grid.cgrid - -Module contents ---------------- - -.. automodule:: jaxparrow.grid - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/jaxparrow.grid.cgrid.html b/docs/_build/html/jaxparrow.grid.cgrid.html deleted file mode 100644 index e01aa67..0000000 --- a/docs/_build/html/jaxparrow.grid.cgrid.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - jaxparrow.grid.cgrid module — jaxparrow 0.0.1 documentation - - - - - - - - - - - - - - - - - - -
    -
    -
    - - -
    - -
    -

    jaxparrow.grid.cgrid module

    -
    -
    -class jaxparrow.grid.cgrid.CGrid(ssh_lat: ndarray, ssh_lon: ndarray, u_lat: ndarray, u_lon: ndarray, v_lat: ndarray, v_lon: ndarray, ssh_value: ndarray, u_value: ndarray | None = None, v_value: ndarray | None = None, ssh_mask: ndarray | None = None, u_mask: ndarray | None = None, v_mask: ndarray | None = None, u_geos_value: ndarray | None = None, v_geos_value: ndarray | None = None)
    -

    Bases: object

    -

    Class representing the C-grid over which flows will be computed

    -
    -
    -compute_cyclogeostrophy(variational: bool = True, n_it: int | None = None, lr: float = 0.005, eps: float = 0.0001) → Tuple[ndarray | MaskedArray, ndarray | MaskedArray]
    -

    Computes the cyclogeostrophic velocities using either the variational or the iterative approach

    -
    -
    Parameters:
    -
      -

    • variational (bool, optional) – flag indicating which approach to use, defaults to True

      • -

    • n_it (int, optional) – maximum number of iterations, defaults to None

      • -

    • lr (float, optional) – learning rate for the variational method, defaults to cyclo.LR_VAR

      • -

    • eps (float, optional) – residual tolerance for the iterative method, defaults to cyclo.EPSILON_IT

      • -
    -
    -
    Returns:
    -

    U and V cyclogeostrophic velocity fields

    -
    -
    Return type:
    -

    Tuple[Union[np.ndarray, np.ma.MaskedArray], Union[np.ndarray, np.ma.MaskedArray]]

    -
    -
    -
    - -
    -
    -compute_geostrophy() → Tuple[ndarray, ndarray]
    -

    Computes the geostrophic velocities from SSH values and derivatives, and U and V coriolis factor

    -
    -
    Returns:
    -

    U and V geostrophic velocity fields

    -
    -
    Return type:
    -

    Tuple[np.ndarray, np.ndarray]

    -
    -
    -
    - -
    -
    -get_ssh() → Variable
    -

    Getter for SSH field

    -
    -
    Returns:
    -

    SSH field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u() → Variable
    -

    Getter for U reference velocity field

    -
    -
    Returns:
    -

    U reference velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u_cyclo() → Variable
    -

    Getter for U cylogeostrophic velocity field

    -
    -
    Returns:
    -

    U cylogeostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u_geos() → Variable
    -

    Getter for U geostrophic velocity field

    -
    -
    Returns:
    -

    U geostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v() → Variable
    -

    Getter for V reference velocity field

    -
    -
    Returns:
    -

    V reference velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v_cyclo() → Variable
    -

    Getter for V cylogeostrophic velocity field

    -
    -
    Returns:
    -

    V cylogeostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v_geos() → Variable
    -

    Getter for V geostrophic velocity field

    -
    -
    Returns:
    -

    V geostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -set_ssh(ssh: Variable)
    -

    Setter for SSH field

    -
    -
    Parameters:
    -

    ssh – SSH field to set

    -
    -
    Type:
    -

    variable.Field

    -
    -
    -
    - -
    -
    -set_u(u: Variable)
    -

    Setter for U reference velocity field

    -
    -
    Parameters:
    -

    u (variable.Variable) – U reference velocity field to set

    -
    -
    -
    - -
    -
    -set_u_cyclo(u_cyclo: Variable)
    -

    Setter for U cyclogeostrophic velocity field

    -
    -
    Param:
    -

    U cyclogeostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_u_geos(u_geos: Variable)
    -

    Setter for U geostrophic velocity field

    -
    -
    Parameters:
    -

    u_geos (variable.Variable) – U geostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_v(v: Variable)
    -

    Setter for V reference velocity field

    -
    -
    Parameters:
    -

    v (variable.Variable) – V reference velocity field to set

    -
    -
    -
    - -
    -
    -set_v_cyclo(v_cyclo: Variable)
    -

    Setter for V cyclogeostrophic velocity field

    -
    -
    Parameters:
    -

    v_cyclo (variable.Variable) – V cyclogeostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_v_geos(v_geos: Variable)
    -

    Setter for V geostrophic velocity field

    -
    -
    Parameters:
    -

    v_geos (variable.Variable) – V geostrophic velocity field to set

    -
    -
    -
    - -
    - -
    - - -
    - -
    -
    - -
    -
    -
    - ©2023, Victor Zaia, Vadim Bertrand. - - | - Powered by Sphinx 7.2.6 - & Alabaster 0.7.13 - - | - Page source -
    - - - - - - \ No newline at end of file diff --git a/docs/_build/html/jaxparrow.grid.html b/docs/_build/html/jaxparrow.grid.html deleted file mode 100644 index 260f5b7..0000000 --- a/docs/_build/html/jaxparrow.grid.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - - - jaxparrow.grid package — jaxparrow 0.0.1 documentation - - - - - - - - - - - - - - - - - - -
    -
    -
    - - -
    - -
    -

    jaxparrow.grid package

    -
    -

    Submodules

    -
    - -
    -
    -
    -

    Module contents

    -
    -
    -class jaxparrow.grid.CGrid(ssh_lat: ndarray, ssh_lon: ndarray, u_lat: ndarray, u_lon: ndarray, v_lat: ndarray, v_lon: ndarray, ssh_value: ndarray, u_value: ndarray | None = None, v_value: ndarray | None = None, ssh_mask: ndarray | None = None, u_mask: ndarray | None = None, v_mask: ndarray | None = None, u_geos_value: ndarray | None = None, v_geos_value: ndarray | None = None)
    -

    Bases: object

    -

    Class representing the C-grid over which flows will be computed

    -
    -
    -compute_cyclogeostrophy(variational: bool = True, n_it: int | None = None, lr: float = 0.005, eps: float = 0.0001) → Tuple[ndarray | MaskedArray, ndarray | MaskedArray]
    -

    Computes the cyclogeostrophic velocities using either the variational or the iterative approach

    -
    -
    Parameters:
    -
      -

    • variational (bool, optional) – flag indicating which approach to use, defaults to True

      • -

    • n_it (int, optional) – maximum number of iterations, defaults to None

      • -

    • lr (float, optional) – learning rate for the variational method, defaults to cyclo.LR_VAR

      • -

    • eps (float, optional) – residual tolerance for the iterative method, defaults to cyclo.EPSILON_IT

      • -
    -
    -
    Returns:
    -

    U and V cyclogeostrophic velocity fields

    -
    -
    Return type:
    -

    Tuple[Union[np.ndarray, np.ma.MaskedArray], Union[np.ndarray, np.ma.MaskedArray]]

    -
    -
    -
    - -
    -
    -compute_geostrophy() → Tuple[ndarray, ndarray]
    -

    Computes the geostrophic velocities from SSH values and derivatives, and U and V coriolis factor

    -
    -
    Returns:
    -

    U and V geostrophic velocity fields

    -
    -
    Return type:
    -

    Tuple[np.ndarray, np.ndarray]

    -
    -
    -
    - -
    -
    -get_ssh() → Variable
    -

    Getter for SSH field

    -
    -
    Returns:
    -

    SSH field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u() → Variable
    -

    Getter for U reference velocity field

    -
    -
    Returns:
    -

    U reference velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u_cyclo() → Variable
    -

    Getter for U cylogeostrophic velocity field

    -
    -
    Returns:
    -

    U cylogeostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_u_geos() → Variable
    -

    Getter for U geostrophic velocity field

    -
    -
    Returns:
    -

    U geostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v() → Variable
    -

    Getter for V reference velocity field

    -
    -
    Returns:
    -

    V reference velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v_cyclo() → Variable
    -

    Getter for V cylogeostrophic velocity field

    -
    -
    Returns:
    -

    V cylogeostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -get_v_geos() → Variable
    -

    Getter for V geostrophic velocity field

    -
    -
    Returns:
    -

    V geostrophic velocity field

    -
    -
    Return type:
    -

    variable.Variable

    -
    -
    -
    - -
    -
    -set_ssh(ssh: Variable)
    -

    Setter for SSH field

    -
    -
    Parameters:
    -

    ssh – SSH field to set

    -
    -
    Type:
    -

    variable.Field

    -
    -
    -
    - -
    -
    -set_u(u: Variable)
    -

    Setter for U reference velocity field

    -
    -
    Parameters:
    -

    u (variable.Variable) – U reference velocity field to set

    -
    -
    -
    - -
    -
    -set_u_cyclo(u_cyclo: Variable)
    -

    Setter for U cyclogeostrophic velocity field

    -
    -
    Param:
    -

    U cyclogeostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_u_geos(u_geos: Variable)
    -

    Setter for U geostrophic velocity field

    -
    -
    Parameters:
    -

    u_geos (variable.Variable) – U geostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_v(v: Variable)
    -

    Setter for V reference velocity field

    -
    -
    Parameters:
    -

    v (variable.Variable) – V reference velocity field to set

    -
    -
    -
    - -
    -
    -set_v_cyclo(v_cyclo: Variable)
    -

    Setter for V cyclogeostrophic velocity field

    -
    -
    Parameters:
    -

    v_cyclo (variable.Variable) – V cyclogeostrophic velocity field to set

    -
    -
    -
    - -
    -
    -set_v_geos(v_geos: Variable)
    -

    Setter for V geostrophic velocity field

    -
    -
    Parameters:
    -

    v_geos (variable.Variable) – V geostrophic velocity field to set

    -
    -
    -
    - -
    - -
    -
    - - -
    - -
    -
    - -
    -
    -
    - ©2023, Victor Zaia, Vadim Bertrand. - - | - Powered by Sphinx 7.2.6 - & Alabaster 0.7.13 - - | - Page source -
    - - - - - - \ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv deleted file mode 100644 index 5dd8969..0000000 Binary files a/docs/_build/html/objects.inv and /dev/null differ diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js deleted file mode 100644 index 3a5906f..0000000 --- a/docs/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"docnames": ["index", "jaxparrow", "jaxparrow.cyclogeostrophy", "jaxparrow.geostrophy", "jaxparrow.grid", "jaxparrow.grid.cgrid", "jaxparrow.tools", "jaxparrow.tools.tools", "modules", "usage"], "filenames": ["index.rst", "jaxparrow.rst", "jaxparrow.cyclogeostrophy.rst", "jaxparrow.geostrophy.rst", "jaxparrow.grid.rst", "jaxparrow.grid.cgrid.rst", "jaxparrow.tools.rst", "jaxparrow.tools.tools.rst", "modules.rst", "usage.rst"], "titles": ["Welcome to jaxparrow\u2019s documentation!", "jaxparrow package", "jaxparrow.cyclogeostrophy module", "jaxparrow.geostrophy module", "jaxparrow.grid package", "jaxparrow.grid.cgrid module", "jaxparrow.tools package", "jaxparrow.tools.tools module", "jaxparrow", "Usage"], "terms": {"usag": 0, "instal": 0, "packag": [0, 8], "index": 0, "modul": [0, 8], "search": 0, "page": 0, "grid": [1, 2, 6, 7, 8], "cgrid": [1, 4], "compute_cyclogeostrophi": [1, 4, 5], "compute_geostrophi": [1, 4, 5], "get_ssh": [1, 4, 5], "get_u": [1, 4, 5], "get_u_cyclo": [1, 4, 5], "get_u_geo": [1, 4, 5], "get_v": [1, 4, 5], "get_v_cyclo": [1, 4, 5], "get_v_geo": [1, 4, 5], "set_ssh": [1, 4, 5], "set_u": [1, 4, 5], "set_u_cyclo": [1, 4, 5], "set_u_geo": [1, 4, 5], "set_v": [1, 4, 5], "set_v_cyclo": [1, 4, 5], "set_v_geo": [1, 4, 5], "tool": [1, 8], "compute_coriolis_factor": [1, 6, 7], "compute_spatial_step": [1, 6, 7], "cyclogeostrophi": [1, 8], "lr_var": [1, 2, 4, 5, 8], "n_it_it": [1, 2, 8], "n_it_var": [1, 2, 8], "res_eps_it": [1, 2, 8], "res_filter_size_it": [1, 2, 8], "res_init_it": [1, 2, 8], "geostrophi": [1, 8], "u_geo": [1, 2, 4, 5, 6, 7], "ndarrai": [1, 2, 3, 4, 5, 6, 7], "maskedarrai": [1, 2, 3, 4, 5, 6, 7], "v_geo": [1, 2, 4, 5, 6, 7], "dx_u": [1, 2, 6, 7], "dx_v": [1, 2, 6, 7], "dy_u": [1, 2, 6, 7], "dy_v": [1, 2, 6, 7], "coriolis_factor_u": [1, 2, 3, 6, 7], "coriolis_factor_v": [1, 2, 3, 6, 7], "method": [1, 2, 4, 5], "liter": [1, 2], "variat": [1, 2, 4, 5], "penven": [1, 2], "ioannou": [1, 2], "n_it": [1, 2, 4, 5], "int": [1, 2, 4, 5, 6, 7], "2000": 2, "lr": [1, 2, 4, 5], "float": [1, 2, 4, 5, 6, 7], "0": [1, 2, 4, 5, 6, 7], "005": [1, 2, 4, 5], "res_ep": [1, 2], "0001": [1, 2, 4, 5], "res_init": [1, 2], "str": [], "inf": [], "res_filter_s": [1, 2], "3": [1, 2], "tupl": [1, 2, 3, 4, 5, 6, 7], "comput": [1, 2, 3, 4, 5, 6, 7], "veloc": [1, 2, 3, 4, 5, 6, 7], "from": [1, 2, 4, 5, 6, 7], "cyclogeostroph": [1, 2, 4, 5, 6, 7], "approxim": [1, 2, 6, 7], "us": [1, 2, 4, 5, 6, 7, 9], "default": [1, 2, 4, 5, 6, 7], "iter": [1, 2, 4, 5], "paramet": [1, 2, 3, 4, 5, 6, 7], "union": [1, 2, 3, 4, 5, 6, 7], "np": [1, 2, 3, 4, 5, 6, 7], "ma": [1, 2, 3, 4, 5, 6, 7], "u": [1, 2, 3, 4, 5, 6, 7], "geostroph": [1, 2, 3, 4, 5, 6, 7], "valu": [1, 2, 3, 4, 5, 6, 7], "v": [1, 2, 3, 4, 5, 6, 7], "spatial": [1, 2, 3, 6, 7], "step": [1, 2, 3, 6, 7], "along": [1, 2, 3, 6, 7], "x": [1, 2, 3, 6, 7], "y": [1, 2, 3, 6, 7], "corioli": [1, 2, 3, 4, 5, 6, 7], "factor": [1, 2, 3, 4, 5, 6, 7], "option": [1, 2, 4, 5, 6, 7], "numer": [1, 2], "maximum": [1, 2, 4, 5], "number": [1, 2, 4, 5], "gradient": [1, 2], "descent": [1, 2], "learn": [1, 2, 4, 5], "rate": [1, 2, 4, 5], "residu": [1, 2, 4, 5], "toler": [1, 2, 4, 5], "ar": [1, 2], "smaller": [1, 2], "we": [1, 2], "consid": [1, 2], "them": [1, 2], "equal": [1, 2], "eps_it": [1, 2], "initi": [1, 2], "larger": [1, 2], "first": [1, 2, 9], "solut": [1, 2], "diverg": [1, 2], "If": [1, 2], "same": [1, 2], "absolut": [1, 2], "size": [1, 2], "convolut": [1, 2], "filter": [1, 2], "when": [1, 2], "return": [1, 2, 3, 4, 5, 6, 7], "type": [1, 2, 3, 4, 5, 6, 7], "ssh": [1, 3, 4, 5], "dx_ssh": [1, 3], "dy_ssh": [1, 3], "balanc": [1, 3], "sea": [1, 3], "surfac": [1, 3], "height": [1, 3], "approach": [2, 4, 5], "100": [2, 6, 7], "point": 2, "": 2, "dure": 2, "class": [4, 5], "ssh_lat": [4, 5], "ssh_lon": [4, 5], "u_lat": [4, 5], "u_lon": [4, 5], "v_lat": [4, 5], "v_lon": [4, 5], "ssh_valu": [4, 5], "u_valu": [4, 5], "none": [1, 2, 4, 5], "v_valu": [4, 5], "ssh_mask": [4, 5], "u_mask": [4, 5], "v_mask": [4, 5], "u_geos_valu": [4, 5], "v_geos_valu": [4, 5], "base": [4, 5], "object": [4, 5], "repres": [4, 5], "c": [4, 5], "over": [4, 5], "which": [4, 5], "flow": [4, 5], "bool": [4, 5], "true": [4, 5], "ep": [4, 5], "either": [4, 5], "flag": [4, 5], "indic": [4, 5], "cyclo": [4, 5], "epsilon_it": [4, 5], "field": [4, 5], "deriv": [4, 5], "variabl": [4, 5], "getter": [4, 5], "refer": [4, 5], "cylogeostroph": [4, 5], "setter": [4, 5], "set": [4, 5, 6, 7], "u_cyclo": [4, 5, 6, 7], "param": [4, 5], "v_cyclo": [4, 5, 6, 7], "lat": [6, 7], "latitud": [6, 7], "lon": [6, 7], "bound": [6, 7], "10000": [6, 7], "fill_valu": [6, 7], "1000000000000": [6, 7], "dx": [6, 7], "dy": [6, 7], "defin": [6, 7], "It": [6, 7], "make": [6, 7], "distanc": [6, 7], "sphere": [6, 7], "formula": [6, 7], "taylor": [6, 7], "expans": [6, 7], "co": [6, 7], "arcco": [6, 7], "function": [6, 7], "avoid": [6, 7], "truncat": [6, 7], "issu": [6, 7], "longitud": [6, 7], "rang": [6, 7], "accept": [6, 7], "1e2": [6, 7], "1e4": [6, 7], "out": [6, 7], "thi": [6, 7], "fill": [6, 7], "1e12": [6, 7], "subpackag": 8, "submodul": 8, "content": 8, "To": 9, "jaxparrow": 9, "pip": 9, "venv": 9, "compute_cyclogeostrophic_rmse_jax": [], "arrai": [6, 7], "rmse": [], "jax": [6, 7], "loss": [6, 7], "compute_cyclogeostrophic_diff_jax": [1, 6, 7], "imbal": [6, 7], "numpi": []}, "objects": {"": [[1, 0, 0, "-", "jaxparrow"]], "jaxparrow": [[2, 0, 0, "-", "cyclogeostrophy"], [3, 0, 0, "-", "geostrophy"], [4, 0, 0, "-", "grid"], [6, 0, 0, "-", "tools"]], "jaxparrow.cyclogeostrophy": [[2, 1, 1, "", "LR_VAR"], [2, 1, 1, "", "N_IT_IT"], [2, 1, 1, "", "N_IT_VAR"], [2, 1, 1, "", "RES_EPS_IT"], [2, 1, 1, "", "RES_FILTER_SIZE_IT"], [2, 1, 1, "", "RES_INIT_IT"], [2, 2, 1, "", "cyclogeostrophy"]], "jaxparrow.geostrophy": [[3, 2, 1, "", "geostrophy"]], "jaxparrow.grid": [[4, 3, 1, "", "CGrid"], [5, 0, 0, "-", "cgrid"]], "jaxparrow.grid.CGrid": [[4, 4, 1, "", "compute_cyclogeostrophy"], [4, 4, 1, "", "compute_geostrophy"], [4, 4, 1, "", "get_ssh"], [4, 4, 1, "", "get_u"], [4, 4, 1, "", "get_u_cyclo"], [4, 4, 1, "", "get_u_geos"], [4, 4, 1, "", "get_v"], [4, 4, 1, "", "get_v_cyclo"], [4, 4, 1, "", "get_v_geos"], [4, 4, 1, "", "set_ssh"], [4, 4, 1, "", "set_u"], [4, 4, 1, "", "set_u_cyclo"], [4, 4, 1, "", "set_u_geos"], [4, 4, 1, "", "set_v"], [4, 4, 1, "", "set_v_cyclo"], [4, 4, 1, "", "set_v_geos"]], "jaxparrow.grid.cgrid": [[5, 3, 1, "", "CGrid"]], "jaxparrow.grid.cgrid.CGrid": [[5, 4, 1, "", "compute_cyclogeostrophy"], [5, 4, 1, "", "compute_geostrophy"], [5, 4, 1, "", "get_ssh"], [5, 4, 1, "", "get_u"], [5, 4, 1, "", "get_u_cyclo"], [5, 4, 1, "", "get_u_geos"], [5, 4, 1, "", "get_v"], [5, 4, 1, "", "get_v_cyclo"], [5, 4, 1, "", "get_v_geos"], [5, 4, 1, "", "set_ssh"], [5, 4, 1, "", "set_u"], [5, 4, 1, "", "set_u_cyclo"], [5, 4, 1, "", "set_u_geos"], [5, 4, 1, "", "set_v"], [5, 4, 1, "", "set_v_cyclo"], [5, 4, 1, "", "set_v_geos"]], "jaxparrow.tools": [[6, 2, 1, "", "compute_coriolis_factor"], [6, 2, 1, "", "compute_cyclogeostrophic_diff_jax"], [6, 2, 1, "", "compute_spatial_step"], [7, 0, 0, "-", "tools"]], "jaxparrow.tools.tools": [[7, 2, 1, "", "compute_coriolis_factor"], [7, 2, 1, "", "compute_cyclogeostrophic_diff_jax"], [7, 2, 1, "", "compute_spatial_step"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:function", "3": "py:class", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "function", "Python function"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"]}, "titleterms": {"welcom": 0, "jaxparrow": [0, 1, 2, 3, 4, 5, 6, 7, 8], "": 0, "document": 0, "content": [0, 1, 4, 6], "indic": 0, "tabl": 0, "packag": [1, 4, 6], "subpackag": 1, "submodul": [1, 4, 6], "modul": [1, 2, 3, 4, 5, 6, 7], "cyclogeostrophi": 2, "geostrophi": 3, "grid": [4, 5], "cgrid": 5, "tool": [6, 7], "usag": 9, "instal": 9}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to jaxparrow\u2019s documentation!": [[0, "welcome-to-jaxparrow-s-documentation"]], "Contents:": [[0, "contents"]], "Indices and tables": [[0, "indices-and-tables"]], "jaxparrow": [[8, "jaxparrow"]], "Usage": [[9, "usage"]], "Installation": [[9, "installation"]], "Submodules": [[4, "submodules"], [1, "submodules"], [6, "submodules"]], "Module contents": [[4, "module-jaxparrow.grid"], [1, "module-jaxparrow"], [6, "module-jaxparrow.tools"]], "jaxparrow.grid package": [[4, "jaxparrow-grid-package"]], "jaxparrow.grid.cgrid module": [[5, "module-jaxparrow.grid.cgrid"]], "jaxparrow package": [[1, "jaxparrow-package"]], "Subpackages": [[1, "subpackages"]], "jaxparrow.cyclogeostrophy module": [[2, "module-jaxparrow.cyclogeostrophy"]], "jaxparrow.geostrophy module": [[3, "module-jaxparrow.geostrophy"]], "jaxparrow.tools package": [[6, "jaxparrow-tools-package"]], "jaxparrow.tools.tools module": [[7, "module-jaxparrow.tools.tools"]]}, "indexentries": {"cyclogeostrophy() (in module jaxparrow)": [[1, "jaxparrow.cyclogeostrophy"]], "geostrophy() (in module jaxparrow)": [[1, "jaxparrow.geostrophy"]], "jaxparrow": [[1, "module-jaxparrow"]], "module": [[1, "module-jaxparrow"], [2, "module-jaxparrow.cyclogeostrophy"], [3, "module-jaxparrow.geostrophy"], [6, "module-jaxparrow.tools"], [7, "module-jaxparrow.tools.tools"]], "lr_var (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.LR_VAR"]], "n_it_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.N_IT_IT"]], "n_it_var (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.N_IT_VAR"]], "res_eps_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_EPS_IT"]], "res_filter_size_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_FILTER_SIZE_IT"]], "res_init_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_INIT_IT"]], "cyclogeostrophy() (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.cyclogeostrophy"]], "jaxparrow.cyclogeostrophy": [[2, "module-jaxparrow.cyclogeostrophy"]], "geostrophy() (in module jaxparrow.geostrophy)": [[3, "jaxparrow.geostrophy.geostrophy"]], "jaxparrow.geostrophy": [[3, "module-jaxparrow.geostrophy"]], "compute_coriolis_factor() (in module jaxparrow.tools)": [[6, "jaxparrow.tools.compute_coriolis_factor"]], "compute_cyclogeostrophic_diff_jax() (in module jaxparrow.tools)": [[6, "jaxparrow.tools.compute_cyclogeostrophic_diff_jax"]], "compute_spatial_step() (in module jaxparrow.tools)": [[6, "jaxparrow.tools.compute_spatial_step"]], "jaxparrow.tools": [[6, "module-jaxparrow.tools"]], "compute_coriolis_factor() (in module jaxparrow.tools.tools)": [[7, "jaxparrow.tools.tools.compute_coriolis_factor"]], "compute_cyclogeostrophic_diff_jax() (in module jaxparrow.tools.tools)": [[7, "jaxparrow.tools.tools.compute_cyclogeostrophic_diff_jax"]], "compute_spatial_step() (in module jaxparrow.tools.tools)": [[7, "jaxparrow.tools.tools.compute_spatial_step"]], "jaxparrow.tools.tools": [[7, "module-jaxparrow.tools.tools"]]}}) \ No newline at end of file diff --git a/docs/_build/html/index.html b/docs/_build/index.html similarity index 98% rename from docs/_build/html/index.html rename to docs/_build/index.html index 542d45d..3ae150f 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/index.html @@ -112,7 +112,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/jaxparrow.cyclogeostrophy.html b/docs/_build/jaxparrow.cyclogeostrophy.html similarity index 99% rename from docs/_build/html/jaxparrow.cyclogeostrophy.html rename to docs/_build/jaxparrow.cyclogeostrophy.html index 3549d48..4c6d69e 100644 --- a/docs/_build/html/jaxparrow.cyclogeostrophy.html +++ b/docs/_build/jaxparrow.cyclogeostrophy.html @@ -167,7 +167,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/jaxparrow.geostrophy.html b/docs/_build/jaxparrow.geostrophy.html similarity index 98% rename from docs/_build/html/jaxparrow.geostrophy.html rename to docs/_build/jaxparrow.geostrophy.html index 4d9b541..cf41837 100644 --- a/docs/_build/html/jaxparrow.geostrophy.html +++ b/docs/_build/jaxparrow.geostrophy.html @@ -117,7 +117,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/jaxparrow.html b/docs/_build/jaxparrow.html similarity index 79% rename from docs/_build/html/jaxparrow.html rename to docs/_build/jaxparrow.html index 5a11b05..9690009 100644 --- a/docs/_build/html/jaxparrow.html +++ b/docs/_build/jaxparrow.html @@ -13,7 +13,7 @@ - + @@ -37,43 +37,10 @@

    jaxparrow package

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/jaxparrow.tools.html b/docs/_build/jaxparrow.tools.html similarity index 97% rename from docs/_build/html/jaxparrow.tools.html rename to docs/_build/jaxparrow.tools.html index 67ecc0c..49fb2d6 100644 --- a/docs/_build/html/jaxparrow.tools.html +++ b/docs/_build/jaxparrow.tools.html @@ -14,7 +14,7 @@ - + @@ -122,7 +122,7 @@

    Related Topics

  • Documentation overview
    • - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/jaxparrow.tools.tools.html b/docs/_build/jaxparrow.tools.tools.html similarity index 99% rename from docs/_build/html/jaxparrow.tools.tools.html rename to docs/_build/jaxparrow.tools.tools.html index be70815..d2ac638 100644 --- a/docs/_build/html/jaxparrow.tools.tools.html +++ b/docs/_build/jaxparrow.tools.tools.html @@ -139,7 +139,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/modules.html b/docs/_build/modules.html similarity index 94% rename from docs/_build/html/modules.html rename to docs/_build/modules.html index 28e59ed..37d57d7 100644 --- a/docs/_build/html/modules.html +++ b/docs/_build/modules.html @@ -37,11 +37,6 @@

    jaxparrowjaxparrow package

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/objects.inv b/docs/_build/objects.inv new file mode 100644 index 0000000..ecd481d --- /dev/null +++ b/docs/_build/objects.inv @@ -0,0 +1,9 @@ +# Sphinx inventory version 2 +# Project: jaxparrow +# Version: +# The remainder of this file is compressed using zlib. +xڭN0yeq,05І8| _'[([)8Iw=e %^4`wR[ewT#BL()K2^`>ViIq 0 +%_n +7obt9 +$2Z=8Q !ˮHPJxϢCY%phQh ejqEIfײ#ϸ ."{E z|uڰ"EbH@ж7MhB@Bt'`}[~FPython Module Index     jaxparrow.geostrophy - - -     - jaxparrow.grid - - - -     - jaxparrow.grid.cgrid -     @@ -132,7 +122,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/html/search.html b/docs/_build/search.html similarity index 97% rename from docs/_build/html/search.html rename to docs/_build/search.html index bb07544..4cac296 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/search.html @@ -106,7 +106,7 @@

    Related Topics

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/_build/searchindex.js b/docs/_build/searchindex.js new file mode 100644 index 0000000..51a1d3c --- /dev/null +++ b/docs/_build/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["index", "jaxparrow", "jaxparrow.cyclogeostrophy", "jaxparrow.geostrophy", "jaxparrow.tools", "jaxparrow.tools.tools", "modules", "usage"], "filenames": ["index.rst", "jaxparrow.rst", "jaxparrow.cyclogeostrophy.rst", "jaxparrow.geostrophy.rst", "jaxparrow.tools.rst", "jaxparrow.tools.tools.rst", "modules.rst", "usage.rst"], "titles": ["Welcome to jaxparrow\u2019s documentation!", "jaxparrow package", "jaxparrow.cyclogeostrophy module", "jaxparrow.geostrophy module", "jaxparrow.tools package", "jaxparrow.tools.tools module", "jaxparrow", "Usage"], "terms": {"usag": 0, "instal": 0, "packag": [0, 6], "index": 0, "modul": [0, 6], "search": 0, "page": 0, "tool": [1, 6], "compute_coriolis_factor": [1, 4, 5], "compute_spatial_step": [1, 4, 5], "cyclogeostrophi": [1, 6], "lr_var": [1, 2, 6], "n_it_it": [1, 2, 6], "n_it_var": [1, 2, 6], "res_eps_it": [1, 2, 6], "res_filter_size_it": [1, 2, 6], "res_init_it": [1, 2, 6], "geostrophi": [1, 6], "u_geo": [1, 2], "ndarrai": [1, 2, 3, 4, 5], "maskedarrai": [1, 2, 3, 4, 5], "v_geo": [1, 2], "dx_u": [1, 2], "dx_v": [1, 2], "dy_u": [1, 2], "dy_v": [1, 2], "coriolis_factor_u": [1, 2, 3], "coriolis_factor_v": [1, 2, 3], "method": [1, 2], "liter": [1, 2], "variat": [1, 2], "penven": [1, 2], "ioannou": [1, 2], "n_it": [1, 2], "int": [1, 2, 4, 5], "none": [1, 2], "lr": [1, 2], "float": [1, 2, 4, 5], "0": [1, 2, 4, 5], "005": [1, 2], "res_ep": [1, 2], "0001": [1, 2], "res_init": [1, 2], "same": [1, 2], "res_filter_s": [1, 2], "3": [1, 2], "tupl": [1, 2, 3, 4, 5], "comput": [1, 2, 3, 4, 5], "veloc": [1, 2, 3], "from": [1, 2, 4, 5], "cyclogeostroph": [1, 2], "approxim": [1, 2, 4, 5], "us": [1, 2, 4, 5, 7], "default": [1, 2, 4, 5], "iter": [1, 2], "paramet": [1, 2, 3, 4, 5], "union": [1, 2, 3, 4, 5], "np": [1, 2, 3, 4, 5], "ma": [1, 2, 3, 4, 5], "u": [1, 2, 3], "geostroph": [1, 2, 3], "valu": [1, 2, 3, 4, 5], "v": [1, 2, 3], "spatial": [1, 2, 3, 4, 5], "step": [1, 2, 3, 4, 5], "along": [1, 2, 3], "x": [1, 2, 3], "y": [1, 2, 3], "corioli": [1, 2, 3, 4, 5], "factor": [1, 2, 3, 4, 5], "option": [1, 2, 4, 5], "numer": [1, 2], "maximum": [1, 2], "number": [1, 2], "gradient": [1, 2], "descent": [1, 2], "learn": [1, 2], "rate": [1, 2], "residu": [1, 2], "toler": [1, 2], "ar": [1, 2], "smaller": [1, 2], "we": [1, 2], "consid": [1, 2], "them": [1, 2], "equal": [1, 2], "eps_it": [1, 2], "initi": [1, 2], "larger": [1, 2], "first": [1, 2, 7], "solut": [1, 2], "diverg": [1, 2], "If": [1, 2], "absolut": [1, 2], "size": [1, 2], "convolut": [1, 2], "filter": [1, 2], "when": [1, 2], "return": [1, 2, 3, 4, 5], "type": [1, 2, 3, 4, 5], "ssh": [1, 3], "dx_ssh": [1, 3], "dy_ssh": [1, 3], "balanc": [1, 3], "sea": [1, 3], "surfac": [1, 3], "height": [1, 3], "approach": 2, "100": [2, 4, 5], "2000": 2, "grid": [2, 4, 5], "point": 2, "": 2, "dure": 2, "lat": [4, 5], "latitud": [4, 5], "lon": [4, 5], "bound": [4, 5], "10000": [4, 5], "fill_valu": [4, 5], "1000": [4, 5], "dx": [4, 5], "dy": [4, 5], "defin": [4, 5], "It": [4, 5], "make": [4, 5], "distanc": [4, 5], "sphere": [4, 5], "formula": [4, 5], "taylor": [4, 5], "expans": [4, 5], "co": [4, 5], "arcco": [4, 5], "function": [4, 5], "avoid": [4, 5], "truncat": [4, 5], "issu": [4, 5], "longitud": [4, 5], "rang": [4, 5], "accept": [4, 5], "1e2": [4, 5], "1e4": [4, 5], "out": [4, 5], "thi": [4, 5], "set": [4, 5], "fill": [4, 5], "1e12": [4, 5], "subpackag": 6, "submodul": 6, "content": 6, "To": 7, "jaxparrow": 7, "pip": 7, "venv": 7}, "objects": {"": [[1, 0, 0, "-", "jaxparrow"]], "jaxparrow": [[2, 0, 0, "-", "cyclogeostrophy"], [3, 0, 0, "-", "geostrophy"], [4, 0, 0, "-", "tools"]], "jaxparrow.cyclogeostrophy": [[2, 1, 1, "", "LR_VAR"], [2, 1, 1, "", "N_IT_IT"], [2, 1, 1, "", "N_IT_VAR"], [2, 1, 1, "", "RES_EPS_IT"], [2, 1, 1, "", "RES_FILTER_SIZE_IT"], [2, 1, 1, "", "RES_INIT_IT"], [2, 2, 1, "", "cyclogeostrophy"]], "jaxparrow.geostrophy": [[3, 2, 1, "", "geostrophy"]], "jaxparrow.tools": [[4, 2, 1, "", "compute_coriolis_factor"], [4, 2, 1, "", "compute_spatial_step"], [5, 0, 0, "-", "tools"]], "jaxparrow.tools.tools": [[5, 2, 1, "", "compute_coriolis_factor"], [5, 2, 1, "", "compute_spatial_step"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "function", "Python function"]}, "titleterms": {"welcom": 0, "jaxparrow": [0, 1, 2, 3, 4, 5, 6], "": 0, "document": 0, "content": [0, 1, 4], "indic": 0, "tabl": 0, "packag": [1, 4], "subpackag": 1, "submodul": [1, 4], "modul": [1, 2, 3, 4, 5], "cyclogeostrophi": 2, "geostrophi": 3, "tool": [4, 5], "usag": 7, "instal": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to jaxparrow\u2019s documentation!": [[0, "welcome-to-jaxparrow-s-documentation"]], "Contents:": [[0, "contents"]], "Indices and tables": [[0, "indices-and-tables"]], "jaxparrow package": [[1, "jaxparrow-package"]], "Subpackages": [[1, "subpackages"]], "Submodules": [[1, "submodules"], [4, "submodules"]], "Module contents": [[1, "module-jaxparrow"], [4, "module-jaxparrow.tools"]], "jaxparrow.cyclogeostrophy module": [[2, "module-jaxparrow.cyclogeostrophy"]], "jaxparrow.geostrophy module": [[3, "module-jaxparrow.geostrophy"]], "jaxparrow.tools package": [[4, "jaxparrow-tools-package"]], "jaxparrow.tools.tools module": [[5, "module-jaxparrow.tools.tools"]], "jaxparrow": [[6, "jaxparrow"]], "Usage": [[7, "usage"]], "Installation": [[7, "installation"]]}, "indexentries": {"cyclogeostrophy() (in module jaxparrow)": [[1, "jaxparrow.cyclogeostrophy"]], "geostrophy() (in module jaxparrow)": [[1, "jaxparrow.geostrophy"]], "jaxparrow": [[1, "module-jaxparrow"]], "module": [[1, "module-jaxparrow"], [2, "module-jaxparrow.cyclogeostrophy"], [3, "module-jaxparrow.geostrophy"], [4, "module-jaxparrow.tools"], [5, "module-jaxparrow.tools.tools"]], "lr_var (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.LR_VAR"]], "n_it_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.N_IT_IT"]], "n_it_var (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.N_IT_VAR"]], "res_eps_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_EPS_IT"]], "res_filter_size_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_FILTER_SIZE_IT"]], "res_init_it (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.RES_INIT_IT"]], "cyclogeostrophy() (in module jaxparrow.cyclogeostrophy)": [[2, "jaxparrow.cyclogeostrophy.cyclogeostrophy"]], "jaxparrow.cyclogeostrophy": [[2, "module-jaxparrow.cyclogeostrophy"]], "geostrophy() (in module jaxparrow.geostrophy)": [[3, "jaxparrow.geostrophy.geostrophy"]], "jaxparrow.geostrophy": [[3, "module-jaxparrow.geostrophy"]], "compute_coriolis_factor() (in module jaxparrow.tools)": [[4, "jaxparrow.tools.compute_coriolis_factor"]], "compute_spatial_step() (in module jaxparrow.tools)": [[4, "jaxparrow.tools.compute_spatial_step"]], "jaxparrow.tools": [[4, "module-jaxparrow.tools"]], "compute_coriolis_factor() (in module jaxparrow.tools.tools)": [[5, "jaxparrow.tools.tools.compute_coriolis_factor"]], "compute_spatial_step() (in module jaxparrow.tools.tools)": [[5, "jaxparrow.tools.tools.compute_spatial_step"]], "jaxparrow.tools.tools": [[5, "module-jaxparrow.tools.tools"]]}}) \ No newline at end of file diff --git a/docs/_build/html/usage.html b/docs/_build/usage.html similarity index 97% rename from docs/_build/html/usage.html rename to docs/_build/usage.html index d7a84fd..3d059aa 100644 --- a/docs/_build/html/usage.html +++ b/docs/_build/usage.html @@ -99,7 +99,7 @@

    Quick search

    - ©2023, Victor Zaia, Vadim Bertrand. + ©2023, Victor Zaia, Vadim Bertrand, Emmanuel Cosme, Julien Le Sommer. | Powered by Sphinx 7.2.6 diff --git a/docs/conf.py b/docs/conf.py index c3092c1..3064dc4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,4 +36,3 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'alabaster' -html_static_path = ['_static'] diff --git a/docs/jaxparrow.grid.cgrid.rst b/docs/jaxparrow.grid.cgrid.rst deleted file mode 100644 index 213d224..0000000 --- a/docs/jaxparrow.grid.cgrid.rst +++ /dev/null @@ -1,7 +0,0 @@ -jaxparrow.grid.cgrid module -=========================== - -.. automodule:: jaxparrow.grid.cgrid - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/jaxparrow.grid.rst b/docs/jaxparrow.grid.rst deleted file mode 100644 index b955432..0000000 --- a/docs/jaxparrow.grid.rst +++ /dev/null @@ -1,18 +0,0 @@ -jaxparrow.grid package -====================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - jaxparrow.grid.cgrid - -Module contents ---------------- - -.. automodule:: jaxparrow.grid - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/jaxparrow.rst b/docs/jaxparrow.rst index 3bb0560..45065a5 100644 --- a/docs/jaxparrow.rst +++ b/docs/jaxparrow.rst @@ -7,7 +7,6 @@ Subpackages .. toctree:: :maxdepth: 4 - jaxparrow.grid jaxparrow.tools Submodules