Update Docu (again) (#637)

* Scripts fetches and converts ALMA config files into OSKAR files 📟 * Latest configs for ALMA cycles 9, 10, 11 🚑 * Resolved type conflict (was complained about by mypy) 😕 * Updated documentation as suggested in comments to PR #634 ♍ * Adding link to Karabo workshop on Renkulab 📃 * Section 'Show telescope config' belongs to basic examples * Revert "Section 'Show telescope config' belongs to basic examples ". The changes were made in the wrong file. This reverts commit 50e885f. * Moved section up because it's of general interest and not only SRC related. 🍕 * Fixed more formatting issues 📁 * Added module descriptions 👶 * Fixed formatting issues 👅 * Rewritten docu for imaging module 🚻 * Added a link in README and documentation to the Karabo Workshop on Renkulab ⚡ * Added note to limited server resources on Renkulab. * Added 'napoleon' extension. This renders Google docstyle properly. 💗 * Added docu for WSClean imager (as requested) 💃 * Switched to Google docstring wherever possible. 🌚
i4Ds · Dec 20, 2024 · eee7ab3 · eee7ab3
1 parent f2380be
commit eee7ab3
Show file tree

Hide file tree

Showing 9 changed files with 308 additions and 241 deletions.
diff --git a/doc/src/conf.py b/doc/src/conf.py
@@ -40,6 +40,7 @@
     "sphinx_rtd_theme",
     "myst_parser",
     "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
 ]
 
 source_suffix = {

diff --git a/doc/src/index.rst b/doc/src/index.rst
@@ -33,7 +33,7 @@ Modules
    main_features/base_imaging.rst
    main_features/oskar_imaging.rst
    main_features/rascil_imaging.rst
-
+   main_features/wsclean_imaging.rst
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/src/main_features/oskar_imaging.rst b/doc/src/main_features/oskar_imaging.rst
@@ -1,9 +1,9 @@
 karabo.imaging.imager_oskar
-=================
+===========================
 
 Overview
 ------------
-This package summerizes tools and functions to be used with the imager
+This package summarizes tools and functions to be used with the imager
 from the OSKAR backend. This backend does not offer functionality to
 calculate a cleaned image. You must use RASCIL or WSClean.
 

diff --git a/doc/src/main_features/wsclean_imaging.rst b/doc/src/main_features/wsclean_imaging.rst
@@ -0,0 +1,34 @@
+karabo.imaging.imager_wsclean
+=============================
+
+Overview
+------------
+This package summarizes tools and functions to be used with the imager
+based on the WSClean algorithm. 
+
+
+Classes
+-------
+
+.. autoclass:: karabo.imaging.imager_wsclean.WscleanDirtyImager
+   :members:
+   :special-members: __init__
+   :exclude-members: 
+
+
+.. autoclass:: karabo.imaging.imager_wsclean.WscleanImageCleanerConfig
+   :members:
+   :special-members: __init__
+   :exclude-members:
+
+
+.. autoclass:: karabo.imaging.imager_wsclean.WscleanImageCleaner
+   :members:
+   :special-members: __init__
+   :exclude-members:
+
+
+Functions
+---------
+
+.. autofunction:: karabo.imaging.imager_wsclean.create_image_custom_command