Skip to content

Commit

Permalink
Fixes #50: Corrected the readthedocs documentation
Browse files Browse the repository at this point in the history
This fix addresses the issue where the description of the modules were missing.
The problem was due to multiple autolabels were being created.
  • Loading branch information
sambit-giri committed Aug 19, 2024
1 parent 94bcaa4 commit a3fc852
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ There are various manipulation and analysis modules in `Tools21cm`.

* Bubble Statistics: methods to calculate the sizes of the regions of interest and estimate the size distributions

* Cosmological calculators: various functions for calculating some cosmological stuff
* Cosmological calculators: various functions for sevaral cosmological calculations and conversions

* Identifying regions: methods to identify regions of interest in images

Expand All @@ -65,19 +65,24 @@ There are various manipulation and analysis modules in `Tools21cm`.

* Temperature: methods to estimate the brightness temperature

* Radio telescope noise:
* simulate the radio telescope observation strategy
* simulate telescope noise

* Topology: methods to estimate the topology of the region of interest

* Foreground model: methods to simulate and analyse the foreground signal for 21 cm signal

For detailed documentation and how to use them, see `contents page <https://tools21cm.readthedocs.io/contents.html>`_.

.. :noindex::

Under Development
------------------

* Foreground model: methods to simulate and analyse the foreground signal for 21 cm signal
* Primary beam: methods to simulate the primary beam of radio telescope
* Telescope noise:
* simulate the radio telescope observation strategy
* simulate telescope noise
* Topology: methods to estimate the topology of the region of interest
* Radio telescope beam:
* simulate the sensitivity and evolution of the primary beam
* simulate the impact of side-lobes

Contents
========
Expand Down

0 comments on commit a3fc852

Please sign in to comment.