diff options
| author | Aaron LI <aly@aaronly.me> | 2018-07-10 14:34:13 +0800 |
|---|---|---|
| committer | Aaron LI <aly@aaronly.me> | 2018-07-10 14:34:13 +0800 |
| commit | e49b8bf7da7e19721c5c7a6f1306c5fa84cbd1f4 (patch) | |
| tree | ceed416e540c16cb68bff062eecbfeb99744f595 | |
| parent | 9b30169e7e326c3e06bd61de75e9bddcb180d21a (diff) | |
| download | fg21sim-e49b8bf7da7e19721c5c7a6f1306c5fa84cbd1f4.tar.bz2 | |
docs: Update the user guide a little
| -rw-r--r-- | README.rst | 6 | ||||
| -rw-r--r-- | docs/guide.rst | 9 |
2 files changed, 5 insertions, 10 deletions
@@ -99,10 +99,6 @@ Documentations -------------- To get started, read the `User Guide`_. -**WARNING:** -The documentation is *out-of-date* with the current code, and needs -significant updates! - Contributions ------------- @@ -111,7 +107,7 @@ Great! Be sure to consult the guidelines in |CONTRIBUTING.md|_. Authors ------- -* Weitian LI <``weitian@aaronly.me``> +* Weitian LI <``wt@liwt.net``> * Zhixian MA <``zxma_sjtu@qq.com``> diff --git a/docs/guide.rst b/docs/guide.rst index d921ded..0b491b0 100644 --- a/docs/guide.rst +++ b/docs/guide.rst @@ -3,12 +3,11 @@ User Guide ========== This is a simple guide on how to use the **fg21sim** package to carry -out the foregrounds simulation, which produces the all-sky maps of the -enabled foreground components. +out the foregrounds simulation, which produces the all-sky maps or sky +patches of the enabled foreground components. -The simulation of several foreground components uses the semi-empirical -method, thus it requires specific template map(s) and/or -observational/simulation catalog(s) as the input: +The simulation of the following foreground components requires specific +template map(s) and/or observational/simulation catalog(s) as the input: * ``galactic/synchrotron``: requires the Haslam 408 MHz survey as the template map, and the |