aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAaron LI <aaronly.me@outlook.com>2016-10-17 19:35:52 +0800
committerAaron LI <aaronly.me@outlook.com>2016-10-17 19:35:52 +0800
commit9b0c3f98f84897ed8566f9f4950714100fd84571 (patch)
treef71fed3c1c6e1a4fc3b28c5f7ef96611be3327ce /README.rst
downloadfg21sim-gh-pages.tar.bz2
gh-pages: First commit :)gh-pages
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst39
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