From c74ec6af0df0520779b9d1743b1211031c118eaa Mon Sep 17 00:00:00 2001
From: Aaron LI <aly@aaronly.me>
Date: Sat, 22 Dec 2018 21:01:11 +0800
Subject: clusters/main: Update description/comments

Tweak imports a bit.
---
 fg21sim/extragalactic/clusters/main.py | 27 +++++++++++----------------
 1 file changed, 11 insertions(+), 16 deletions(-)

(limited to 'fg21sim')

diff --git a/fg21sim/extragalactic/clusters/main.py b/fg21sim/extragalactic/clusters/main.py
index 0df271c..f471d90 100644
--- a/fg21sim/extragalactic/clusters/main.py
+++ b/fg21sim/extragalactic/clusters/main.py
@@ -1,15 +1,18 @@
-# Copyright (c) 2017-2018 Weitian LI <weitian@aaronly.me>
+# Copyright (c) 2017-2018 Weitian LI <wt@liwt.net>
 # MIT license
 
 """
-Simulate the diffuse radio emissions from galaxy clusters due to
-merger-induced turbulence and/or shock accelerations, e.g.,
-(giant) radio halos, (elongated double) radio relics.
+Simulate the diffuse radio emissions from galaxy clusters.
 
 NOTE
 ----
-There are other types of diffuse radio emissions not considered
-yet, e.g., mini-halos, roundish radio relics.
+Only implement the *giant radio halos* generated by the merger-induced
+turbulence accelerations.  Other types of diffuse radio emissions are not
+considered yet, e.g., mini-halos, radio relics.
+
+NOTE
+----
+Only support to simulate in sky patches, not full-sky mode.
 """
 
 import os
@@ -18,16 +21,16 @@ from collections import OrderedDict
 
 import numpy as np
 
+from . import helper
 from .psformalism import PSFormalism
 from .formation import ClusterFormation
 from .halo import RadioHaloAM
 from .emission import HaloEmission
+from ...sky import get_sky
 from ...share import CONFIGS, COSMO
 from ...utils.io import dataframe_to_csv, pickle_dump, pickle_load
 from ...utils.ds import dictlist_to_dataframe
 from ...utils.convert import JyPerPix_to_K
-from ...sky import get_sky
-from . import helper
 
 
 logger = logging.getLogger(__name__)
@@ -37,12 +40,6 @@ class GalaxyClusters:
     """
     Simulate the diffuse radio emissions from the galaxy clusters.
 
-    NOTE
-    ----
-    Currently only implement the *giant radio halos*, while other types
-    of diffuse emissions are missing, e.g., mini-halos, elongated relics,
-    roundish relics.
-
     Attributes
     ----------
     configs : `~ConfigManager`
@@ -53,9 +50,7 @@ class GalaxyClusters:
     sky : `~SkyBase`
         The sky instance to deal with the simulation sky as well as the
         output map.
-        XXX: current full-sky HEALPix map is NOT supported!
     """
-    # Component name
     compID = "extragalactic/clusters"
     name = "galaxy clusters (halos)"
 
-- 
cgit v1.2.2