aboutsummaryrefslogtreecommitdiffstats
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
downloadfg21sim-9b0c3f98f84897ed8566f9f4950714100fd84571.tar.bz2
gh-pages: First commit :)gh-pages
-rw-r--r--.gitignore24
-rw-r--r--README.rst39
-rw-r--r--index.html17
3 files changed, 80 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..68379df
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,24 @@
+# General things to ignore
+*~
+*.swp
+*.un~
+*_bak
+# Emacs tmp files
+.#*
+
+venv/
+build/
+dist/
+
+# Python
+*.py[cod]
+**/__pycache__
+*.egg
+*.egg-info/
+
+# IPython
+**/.ipynb_checkpoints
+
+# C/C++
+*.o
+*.so
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
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..e8b900c
--- /dev/null
+++ b/index.html
@@ -0,0 +1,17 @@
+<h1 id="realistic-foregrounds-simulation-for-eor-21cm-signal-detection">Realistic Foregrounds Simulation for EoR 21cm Signal Detection</h1>
+<p><strong>WARNING:</strong> This repository is at its very early stage and under heavy development, do <em>NOT</em> use at the moment!</p>
+<p><strong>NOTE:</strong> Only Python 3 (&gt;= 3.4) is supported!</p>
+<p>This package provides the tools to simulate the <em>realistic</em> 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).</p>
+<h2 id="contributions">Contributions</h2>
+<p>Great! Be sure to consult the guidelines in <code>CONTRIBUTING.md</code>.</p>
+<h2 id="authors">Authors</h2>
+<ul>
+<li>Weitian LI &lt;<code>liweitianux@live.com</code>&gt;</li>
+</ul>
+<h2 id="license">License</h2>
+<p>Unless otherwise declared:</p>
+<ul>
+<li>Codes developed by our are distributed under the <a href="https://opensource.org/licenses/mit-license.php">MIT license</a>;</li>
+<li>Documentations and products generated by our are distributed under the <a href="https://creativecommons.org/licenses/by/3.0/us/deed.en_US">Creative Commons Attribution 3.0 license</a>;</li>
+<li>Third-party codes and products used are distributed under their own licenses.</li>
+</ul>