aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: e1274cf5a4dae891cc92c3987117caff53271786 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Realistic Foregrounds Simulation for EoR 21cm Signal Detection
==============================================================

**WARNING:**
This package is still under heavy development, and may lack some
necessary features or even fail to run correctly.
It is *NOT* recommended to use it at the moment!
Nevertheless, *tests and feedback* are always welcome!


This package provides the tools to simulate the *realistic*
low-frequency radio foregrounds, which can be further
used to test various foreground removal or separation methods, for the
purpose of successfully detecting the 21cm cosmological signal arising
from the netrual hydrogen (HI) at epoch of reionization (EoR).


Requirements
------------
- Python: >= 3.4 (lower versions are not tested and may work)


Contributions
-------------
Great!  Be sure to consult the guidelines in ``CONTRIBUTING.md``.


Authors
-------
- Weitian LI <``liweitianux@live.com``>


Contributors
------------
- Zhixian MA <``zxma_sjtu@qq.com``>


License
-------
Unless otherwise declared:

- Codes developed by us are distributed under the `MIT License`_;
- Documentations and products generated by us are distributed under the
  `Creative Commons Attribution 3.0 License`_;
- Third-party codes and products used are distributed under their own
  licenses.  See also ``LICENSE-3RDPARTY``.


.. _`MIT License`: https://opensource.org/licenses/MIT
.. _`Creative Commons Attribution 3.0 License`: https://creativecommons.org/licenses/by/3.0/us/deed.en_US