Merge pull request #92 from vadmbertr/methods-names

Methods names

Author: vadmbertr

docs/examples/gradient_wind.ipynb

@@ -50,7 +50,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {
     "tags": [
      "hide-input"
@@ -59,7 +59,7 @@
    "outputs": [],
    "source": [
     "R0 = 50e3\n",
-    "ETA0 = .2\n",
+    "ETA0 = -.2\n",
     "LAT0 = 36\n",
     "\n",
     "dxy = 5e3"
@@ -74,16 +74,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "metadata": {
     "tags": [
      "hide-input"
     ]
    },
    "outputs": [],
    "source": [
-    "def simulate_gaussian_ssh(R0, eta0, R):\n",
-    "    return -eta0 * jnp.exp(-(R / R0)**2)\n",
+    "def simulate_gaussian_ssh(R0, eta0, r):\n",
+    "    return -eta0 * jnp.exp((r / R0)**2)\n",
     "\n",
     "\n",
     "def simulate_gaussian_geos(R0, X, Y, ssh, coriolis_factor):\n",
@@ -94,11 +94,11 @@
     "    return u_geos, v_geos\n",
     "\n",
     "\n",
-    "def simulate_gaussian_cyclo(R0, X, Y, R, ssh, coriolis_factor):\n",
-    "    azim_geos = -(2 * geometry.GRAVITY * R * ssh / (coriolis_factor * R0 ** 2))\n",
-    "    azim_cyclo = 2 * azim_geos / (1 + jnp.sqrt(1 + 4 * azim_geos / (coriolis_factor * R)))\n",
-    "    u_cyclo = -azim_cyclo * Y / R\n",
-    "    v_cyclo = azim_cyclo * X / R\n",
+    "def simulate_gaussian_cyclo(R0, X, Y, r, ssh, coriolis_factor):\n",
+    "    azim_geos = -(2 * geometry.GRAVITY * r * ssh / (coriolis_factor * R0 ** 2))\n",
+    "    azim_cyclo = 2 * azim_geos / (1 + jnp.sqrt(1 + 4 * azim_geos / (coriolis_factor * r)))\n",
+    "    u_cyclo = -azim_cyclo * Y / r\n",
+    "    v_cyclo = azim_cyclo * X / r\n",
     "    return u_cyclo, v_cyclo\n",
     "\n",
     "\n",

jaxparrow/__init__.py

@@ -1,4 +1,3 @@
-from .__main__ import main  # noqa
 from .cyclogeostrophy import cyclogeostrophy
 from .geostrophy import geostrophy
 from .version import __version__  # noqa