aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst85
1 files changed, 79 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 643137c..52aef30 100644
--- a/README.rst
+++ b/README.rst
@@ -16,9 +16,82 @@ purpose of successfully detecting the 21cm cosmological signal arising
from the netrual hydrogen (HI) at epoch of reionization (EoR).
+Features
+--------
+* Supported foreground components:
+
+ + ``galactic/synchrotron``:
+ Galactic synchrotron emission (*Note:* only *unpolarized* considered now)
+ + ``galactic/freefree``:
+ Galactic free-free emission
+ + ``galactic/snr``:
+ Emission from Galactic supernovae remnants (SNRs)
+ + ``extragalactic/clusters``:
+ Emission from extragalactic clusters of galaxies
+ (*Note:* only radio *halos* considered at the moment)
+ + ``extragalactic/pointsources``:
+ Emission from multiple types of extragalactic discrete point sources
+ (*Note:* this component was contributed by Zhixian MA, and is not well
+ integrated and tested at the moment)
+
+ Current supported point sources types:
+
+ - star-forming galaxies
+ - star-bursting galaxies
+ - radio-quiet AGNs
+ - Fanaroff-Riley type I (FRI) AGNs
+ - Fanaroff-Riley type II (FRII) AGNs
+
+* All-sky simulation
+ (*Note:* partial-sky simulation not supported yet)
+* Configuration file allowing fine-grained control
+* Modular and well-designed API
+* Easy-to-use command line tools (CLI)
+* Full-featured Web UI
+ (*Note:* recent Firefox, Chrome/Chromium, Edge, and IE >=11 are supported)
+* Handy utilities
+
+
Requirements
------------
-- Python: >= 3.4 (lower versions are not tested and may work)
+* Linux operating system (other UNIX-like systems not tested)
+* `Python <https://www.python.org/>`_: >= 3.4
+* `CFITSIO <https://heasarc.gsfc.nasa.gov/fitsio/fitsio.html>`_
+* `HEALPix <http://healpix.sourceforge.net/>`_:
+ only the C++ library (e.g., package ``libhealpix-cxx0`` on Debian Linux)
+ required by `healpy <https://github.com/healpy/healpy>`_.
+* `LLVM <http://llvm.org/>`_: = 3.8
+ (required by `llvmlite <http://llvmlite.pydata.org/>`_ which is a
+ dependency of `Numba <http://numba.pydata.org/>`_)
+
+
+Installation
+------------
+1. Clone this repository::
+
+ $ git clone https://github.com/liweitianux/fg21sim
+
+2. Install the system requirements: CFITSIO, HEALPix, and LLVM.
+
+3. Install the required third-party Python packages.
+ And it is recommended to use the *virtual environment*::
+
+ $ cd fg21sim/
+ $ make venv
+ $ . ./venv/bin/activate
+
+ Check to make sure this virtual environment is active and the
+ default ``python3`` and ``pip3`` is pointed to the virtual environment.
+
+4. Install this ``fg21sim`` package to the virtual environment::
+
+ $ python3 setup.py install
+
+5. Great! You are ready to use this package.
+ Just have a look, e.g.::
+
+ $ fg21sim --help
+ $ fg21sim-webui --help
Contributions
@@ -28,22 +101,22 @@ Great! Be sure to consult the guidelines in |CONTRIBUTING.md|_.
Authors
-------
-- Weitian LI <``liweitianux@live.com``>
+* Weitian LI <``liweitianux@live.com``>
Contributors
------------
-- Zhixian MA <``zxma_sjtu@qq.com``>
+* 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
+* 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
+* Third-party codes and products used are distributed under their own
licenses. See also |LICENSE-3RDPARTY|_.