diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a6e98bb --- /dev/null +++ b/README.rst @@ -0,0 +1,39 @@ +Realistic Foregrounds Simulation for EoR 21cm Signal Detection +============================================================== + +**WARNING:** +This repository is at its very early stage and under heavy development, +do *NOT* use at the moment! + +**NOTE:** +Only Python 3 (>= 3.4) is supported! + +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) of epoch of reionization (EoR). + + +Contributions +------------- +Great! Be sure to consult the guidelines in ``CONTRIBUTING.md``. + + +Authors +------- + +- Weitian LI <``liweitianux@live.com``> + + +License +------- +Unless otherwise declared: + +- Codes developed by our are distributed under the `MIT license`_; +- Documentations and products generated by our are distributed under the `Creative Commons Attribution 3.0 license`_; +- Third-party codes and products used are distributed under their own licenses. + + +.. _`MIT license`: https://opensource.org/licenses/mit-license.php +.. _`Creative Commons Attribution 3.0 license`: https://creativecommons.org/licenses/by/3.0/us/deed.en_US |