docs: updated hera_sim_tour

HERA-Team · Aug 27, 2024 · 17b28e5 · 17b28e5
1 parent c3f17ca
commit 17b28e5
Show file tree

Hide file tree

Showing 3 changed files with 224 additions and 264 deletions.
diff --git a/docs/tutorials/hera_sim_defaults.ipynb b/docs/tutorials/hera_sim_defaults.ipynb
diff --git a/docs/tutorials/hera_sim_tour.ipynb b/docs/tutorials/hera_sim_tour.ipynb
diff --git a/docs/tutorials/visibility_simulator.ipynb b/docs/tutorials/visibility_simulator.ipynb
@@ -800,16 +800,15 @@
    "source": [
     "from hera_sim.visibilities import VisibilitySimulator\n",
     "\n",
-    "help(\n",
-    "    VisibilitySimulator\n",
-    ")  # You may also try VisibilitySimulator?? which will likely open another window"
+    "# You may also try VisibilitySimulator?? which will likely open another window\n",
+    "help(VisibilitySimulator)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "A custom simulator can be made by subclassing the `VisibilitySimulator` class and overriding the `simulate` method, which must take a `ModelData` object as an input and must return a Numpy array with the same shap as `UVData.data_array`. The `validate` method may be override, and `point_source_ability` and `diffuse_ability`atrributes may be set, as neccessary.\n",
+    "A custom simulator can be made by subclassing the `VisibilitySimulator` class and overriding the `simulate` method, which must take a `ModelData` object as an input and must return a Numpy array with the same shap as `UVData.data_array`. The `validate` method *may* be overriden, and `point_source_ability` and `diffuse_ability`atrributes may be set, as neccessary.\n",
     "\n",
     "Let's take a look at the codes of the `UVSim` class that wraps the pyuvsim simulator as an example. It defines a `simulate` method that calls `pyuvsim.uvsim.run_uvdata_uvsim`, passing in a UVData object from the ModelData input, and returning the `data_array` from the UVData output."
    ]