diff --git a/docs/source/conf.py b/docs/source/conf.py index d3c4aaf..9e92563 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ # for mod_name in MOCK_MODULES: # sys.modules[mod_name] = mock.Mock() -import oceans_sf +import fluidsf # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information diff --git a/docs/source/ex1.ipynb b/docs/source/ex1.ipynb index 461c56f..79fc1c1 100644 --- a/docs/source/ex1.ipynb +++ b/docs/source/ex1.ipynb @@ -125,9 +125,9 @@ "metadata": {}, "outputs": [], "source": [ - "import oceans_sf as ocsf\n", + "import fluidsf\n", "\n", - "sf = ocsf.generate_structure_functions(u, v, x, y)" + "sf = fluidsf.generate_structure_functions(u, v, x, y)" ] }, { @@ -229,7 +229,7 @@ "metadata": {}, "outputs": [], "source": [ - "sf_all = ocsf.generate_structure_functions(u, v, x, y, scalar=q, traditional_order=3)" + "sf_all = fluidsf.generate_structure_functions(u, v, x, y, scalar=q, traditional_order=3)" ] }, { diff --git a/docs/source/ex2.ipynb b/docs/source/ex2.ipynb index 9817b53..84bd3a3 100644 --- a/docs/source/ex2.ipynb +++ b/docs/source/ex2.ipynb @@ -84,10 +84,10 @@ "metadata": {}, "outputs": [], "source": [ - "import oceans_sf as ocsf\n", + "import fluidsf\n", "\n", "sfs_list = [\n", - " ocsf.generate_structure_functions(u[d][0], v[d][0], x, y) \n", + " fluidsf.generate_structure_functions(u[d][0], v[d][0], x, y) \n", " for d in u.keys()]" ] }, diff --git a/docs/source/index.rst b/docs/source/index.rst index 9454cbe..117e297 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,4 @@ -oceans_sf Documentation +FluidSF Documentation ======================= .. toctree:: @@ -14,7 +14,7 @@ oceans_sf Documentation Overview ******** -oceans_sf is a Python package for calculating structure functions from oceanographic data. +FluidSF is a Python package for calculating structure functions from fluid data. These structure functions can be used to estimate turbulence cascade rates without the constraints of spectral methods. This package serves as a useful tool for analyzing turbulent dynamics in the ocean. @@ -32,8 +32,8 @@ Usage Development and Contributing **************************** -The development of oceans_sf started as a Ph.D. project for Cassidy Wagner, +The development of FluidSF started as a Ph.D. project for Cassidy Wagner, advised by Brodie Pearson. The developers welcome contributions and suggestions -through the `oceans_sf GitHub repository `_ +through the `FluidSF GitHub repository `_ Feel free to open an issue, submit a pull request, and/or `contact the owner directly `_. \ No newline at end of file diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 9a00ff5..9b53cc9 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,8 +1,8 @@ Installation instructions ========================= -Fork or clone the `oceans_sf repository `_ to your local machine. -Install oceans_sf with pip: +Fork or clone the `FluidSF repository `_ to your local machine. +Install FluidSF with pip: .. code-block:: bash diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 9198230..1f1eec8 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -4,4 +4,4 @@ Functions .. toctree:: :maxdepth: 4 - oceans_sf + FluidSF diff --git a/docs/source/oceans_sf.rst b/docs/source/oceans_sf.rst index eb3f0d3..30c42e5 100644 --- a/docs/source/oceans_sf.rst +++ b/docs/source/oceans_sf.rst @@ -1,9 +1,9 @@ -oceans\_sf package +FluidSF package -oceans\_sf function documentation +FluidSF function documentation --------------------------------- -.. automodule:: oceans_sf +.. automodule:: fluidsf :members: :undoc-members: :show-inheritance: diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 3e6b644..4ec5601 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -1,6 +1,6 @@ -Overview of Oceans SF +Overview of FluidSF ====================== -oceans_sf is a Python package for calculating structure functions from oceanographic data. +FluidSF is a Python package for calculating structure functions from fluid data. These structure functions can be used to estimate turbulence cascade rates without the constraints of spectral methods. This package serves as a useful tool for analyzing turbulent dynamics in the ocean. \ No newline at end of file