diff options
| author | Aaron LI <aaronly.me@outlook.com> | 2016-11-25 09:52:28 +0800 |
|---|---|---|
| committer | Aaron LI <aaronly.me@outlook.com> | 2016-11-25 09:52:28 +0800 |
| commit | 1d53d114be089b2035ecd1ae6ef69cf9e946a1ca (patch) | |
| tree | 7800ca12b1ed9ad6d64238c224a774561503e492 /README.rst | |
| parent | 71e70b2ef185da3a3d8f0a17463b4a8c68e6bd43 (diff) | |
| download | fg21sim-1d53d114be089b2035ecd1ae6ef69cf9e946a1ca.tar.bz2 | |
README.rst: Update WARNING and Requirements; Add "Contributors"
And other minor fixes/changes.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 31 |
1 files changed, 20 insertions, 11 deletions
@@ -2,17 +2,22 @@ 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! +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! -**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). +from the netrual hydrogen (HI) at epoch of reionization (EoR). + + +Requirements +------------ +- Python: >= 3.4 (lower versions are not tested and may work) Contributions @@ -22,20 +27,24 @@ 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 our are distributed under the `MIT license`_; -- Documentations and products generated by our are distributed under the - `Creative Commons Attribution 3.0 license`_; +- 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 +.. _`MIT License`: https://opensource.org/licenses/MIT +.. _`Creative Commons Attribution 3.0 License`: https://creativecommons.org/licenses/by/3.0/us/deed.en_US |