feat: Issue #48 feature 1

.gitignore

@@ -16,3 +16,6 @@ docs/_build/
 _version.py
 _autosummary/
 coverage.xml
+.ipynb_checkpoints
+.pytest_cache/
+__pycache__/

docs/conf.py

@@ -1,13 +1,10 @@
 """Configuration for docs."""
 
 import os
-from datetime import datetime, timezone
-
-from tuesday import __version__
-
+from datetime import UTC, datetime
 from unittest.mock import MagicMock
 
-sys.path.insert(0, str(Path(__file__).absolute().parent.parent / "src"))
+from tuesday import __version__
 
 
 class Mock(MagicMock):
@@ -27,7 +24,6 @@ def __getattr__(cls, name):
     "h5py",
     "cached_property",
 ]
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 extensions = [
     "sphinx.ext.autodoc",
@@ -60,7 +56,7 @@ def __getattr__(cls, name):
 source_suffix = ".rst"
 master_doc = "index"
 project = "tuesday"
-year = str(datetime.now(tz=timezone.utc).year)
+year = str(datetime.now(tz=UTC).year)
 author = "21cmFAST Team"
 copyright = f"{year}, {author}"
 version = release = __version__

docs/tutorials/computing_and_plotting_power_spectra.ipynb

@@ -185,14 +185,13 @@
     }
    ],
    "source": [
-    "\n",
     "ax = plot_coeval_slice(\n",
     "    delta_x,\n",
     "    box_len,\n",
     "    transform2slice=coeval2slice_x(idx=15),\n",
     "    title=\"Slice in x-direction\",\n",
-    "    v_x=delta_x[15,...]*un.m / un.s,\n",
-    "    v_y=delta_x[15,...]*un.m / un.s,\n",
+    "    v_x=delta_x[15, ...] * un.m / un.s,\n",
+    "    v_y=delta_x[15, ...] * un.m / un.s,\n",
     "    quiver_decimate_factor=3,\n",
     ")"
    ]
@@ -232,7 +231,10 @@
    ],
    "source": [
     "plot_coeval_slice(\n",
-    "    delta_x.value*un.mK, box_len, transform2slice=coeval2slice_y(), title=\"Slice in y-direction\"\n",
+    "    delta_x.value * un.mK,\n",
+    "    box_len,\n",
+    "    transform2slice=coeval2slice_y(),\n",
+    "    title=\"Slice in y-direction\",\n",
     ")"
    ]
   },
@@ -793,16 +795,16 @@
     "fig, ax = plt.subplots(1, 1, figsize=(18, 7))\n",
     "\n",
     "ax = tuesday.core.plot_power_spectrum(\n",
-    "        ps1d,\n",
-    "        at_k=0.05,\n",
-    "        fontsize=20,\n",
-    "        ax=ax,\n",
-    "        color=f\"r\",\n",
-    "        legend=f\"k ~ 0.05\",\n",
-    "        legend_kwargs={\"frameon\": False},\n",
-    "        logx=False,\n",
-    "        logy=False,\n",
-    "    )\n",
+    "    ps1d,\n",
+    "    at_k=0.05,\n",
+    "    fontsize=20,\n",
+    "    ax=ax,\n",
+    "    color=\"r\",\n",
+    "    legend=\"k ~ 0.05\",\n",
+    "    legend_kwargs={\"frameon\": False},\n",
+    "    logx=False,\n",
+    "    logy=False,\n",
+    ")\n",
     "\n",
     "ax = tuesday.core.plot_power_spectrum(\n",
     "    all_analytic,\n",
@@ -840,16 +842,16 @@
     "fig, ax = plt.subplots(1, 1, figsize=(18, 7))\n",
     "\n",
     "ax = tuesday.core.plot_power_spectrum(\n",
-    "        ps1d,\n",
-    "        fontsize=20,\n",
-    "        ax=ax,\n",
-    "        color=f\"r\",\n",
-    "        at_k=at_k,\n",
-    "        legend=f\"k ~ \"+str(at_k),\n",
-    "        legend_kwargs={\"frameon\": False},\n",
-    "        logx=False,\n",
-    "        logy=False,\n",
-    "    )\n",
+    "    ps1d,\n",
+    "    fontsize=20,\n",
+    "    ax=ax,\n",
+    "    color=\"r\",\n",
+    "    at_k=at_k,\n",
+    "    legend=\"k ~ \" + str(at_k),\n",
+    "    legend_kwargs={\"frameon\": False},\n",
+    "    logx=False,\n",
+    "    logy=False,\n",
+    ")\n",
     "\n",
     "ax = tuesday.core.plot_power_spectrum(\n",
     "    all_analytic,\n",