From 9b30169e7e326c3e06bd61de75e9bddcb180d21a Mon Sep 17 00:00:00 2001
From: Aaron LI <aly@aaronly.me>
Date: Tue, 10 Jul 2018 14:33:31 +0800
Subject: docs: Add a page about template data

Also update the data manifest and the user guide page.
---
 docs/data-manifest.json |  6 ------
 docs/data.rst           | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 docs/guide.rst          |  7 ++-----
 3 files changed, 48 insertions(+), 11 deletions(-)
 create mode 100644 docs/data.rst

(limited to 'docs')

diff --git a/docs/data-manifest.json b/docs/data-manifest.json
index 64ea412..8c6d969 100644
--- a/docs/data-manifest.json
+++ b/docs/data-manifest.json
@@ -5,12 +5,6 @@
     "md5": "9851be15145e77f7f49f301ee54e5a14",
     "url": "https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116026&authkey=AJcYjHaI7O7FEcY"
   },
-  {
-    "filename": "HVP_LCDM_DeepWedge_Catalog.csv",
-    "size": 1093936,
-    "md5": "f9011467812b77c791de9ca60996e210",
-    "url": "https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116028&authkey=AH7-EG_D40kDTF4"
-  },
   {
     "filename": "Halpha_fwhm06_1024.fits",
     "size": 50342400,
diff --git a/docs/data.rst b/docs/data.rst
new file mode 100644
index 0000000..4ad3f9c
--- /dev/null
+++ b/docs/data.rst
@@ -0,0 +1,46 @@
+=============
+Template Data
+=============
+
+The simulation of the following foreground components requires specific
+template map(s) and/or observational/simulation catalog(s) as the input:
+
+* ``galactic/synchrotron``:
+  requires the Haslam 408 MHz survey as the template map, and the
+  spectral index map.
+* ``galactic/freefree``:
+  requires the Hα map and the dust map.
+* ``galactic/snr``:
+  requires the catalog of the Galactic SNRs.
+
+The following template data are provided:
+
+* Galactic SNR catalog:
+  `GalacticSNRs_Green2014.csv <https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116026&authkey=AJcYjHaI7O7FEcY>`_,
+  24981 bytes,
+  MD5 9851be15145e77f7f49f301ee54e5a14
+
+* Galactic Hα all-sky map:
+  `Halpha_fwhm06_1024.fits <https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116034&authkey=AGjsiwZBaZ-ZZLE>`_,
+  50342400 bytes,
+  MD5 1a3ec062818bbdd8254e5158cce90652
+
+* Galactic dust all-sky map:
+  `SFD_i100_ns1024.fits <https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116029&authkey=AAN7DT0JKWpFlyA>`_,
+  50342400 bytes,
+  MD5 e9d6e683f9f6aaa308275196615db17d
+
+* Haslam 408 MHz all-sky survey
+  `haslam408_dsds_Remazeilles2014.fits <https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116032&authkey=AHJyQFnMlp8yOIo>`_,
+  12594240 bytes,
+  MD5 53b99b6e61b80f6c6a603c0a50c9ba51
+
+* Galactic synchrotron spectral index all-sky map:
+  `synchrotron_specind2.fits <https://onedrive.live.com/download?cid=6BC61834227AC6CE&resid=6BC61834227AC6CE%2116033&authkey=ADmJvJ3Shy7M9ig>`_,
+  25176960 bytes,
+  MD5 0bc9899915db805ec1709f0c83ca6617
+
+The above all-sky maps are in HEALPix format.
+Sky patches can be cut out from them using the ``get-healpix-patch`` tool.
+The ``fg21sim-download-data`` tool can also be used to retrieve the above
+template data by providing with the `data manifest <data-manifest.json>`_.
diff --git a/docs/guide.rst b/docs/guide.rst
index cca46fe..d921ded 100644
--- a/docs/guide.rst
+++ b/docs/guide.rst
@@ -17,12 +17,9 @@ observational/simulation catalog(s) as the input:
   requires the Hα map and the dust map.
 * ``galactic/snr``:
   requires the catalog of the Galactic SNRs.
-* ``extragalactic/clusters``:
-  requires the catalog of the clusters of galaxies.
 
-All the required input templates and catalogs can be retrieved using
-the ``fg21sim-download-data`` CLI tool, by providing it with this
-`data manifest <data-manifest.json>`_.
+See the `template data <data.rst>`_ page for more details on the input
+data and how to obtain them.
 
 Then, a configuration file is required to run the foregrounds simulation,
 which controls all aspects of the simulation behaviors.
-- 
cgit v1.2.2