aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 26740e3911f42a72ba53376e5578a709e466db06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
Chandra ACIS Data Analysis Tools
================================

Weitian LI, Junhu GU, and Zhenghao ZHU


Introduction
------------
This repository currently contains the following tools:
+ Chandra ACIS data reduction
+ Point source and flares removal
+ Blanksky reprojection
+ Background spectrum correction
+ Source spectra extraction and deprojection analysis (temperature profile)
+ Surface brightness profile extraction
+ Gravitational mass profile calculation (NFW profile extrapolation)
+ Luminosity and flux calculation

These tools are developed to help and automate our batch analysis of the
big galaxy groups and clusters sample observed by Chandra ACIS.
Therefore, there are many assumptions and hacks in these tools, and many
cleanups are needed.  Last but not least, documents are badly needed.


TODO
----
+ Rewrite more scripts in Python
+ Write more docs


Requirements
------------
+ Python (>=3.5)
+ CIAO (tested with v4.6, v4.9)
+ HEASoft (tested with v6.16, v6.19)


Installation
------------
1. Clone this repository with ``opt_utilities``:

   ```sh
   $ git clone --recursive https://github.com/liweitianux/chandra-acis-analysis.git
   ```

   or in this way:

   ```sh
   $ git clone https://github.com/liweitianux/chandra-acis-analysis.git
   $ cd chandra-acis-analysis
   $ git submodule update --init --recursive
   ```

2. Install the following Python packages:

   ```sh
   $ sudo apt install python3-numpy python3-scipy python3-astropy python3-ruamel.yaml
   ```

   or

   ```sh
   $ pip3 install --user -r requirements.txt
   ```

3. Build tools in ``src`` directory:

   ```sh
   $ cd src
   $ make clean
   $ make [OPENMP=yes]
   $ make install
   ```

Settings
--------
Add the following settings to your shell's initialization file
(e.g., ``~/.bashrc`` or ``~/.zshrc``).

```sh
# Environment variables:
export CHANDRA_ACIS_BIN="<path>/chandra-acis-analysis/bin"

# Handy aliases:
alias fitmass="${CHANDRA_ACIS_BIN}/fit_mass.sh"
alias fitnfw="${CHANDRA_ACIS_BIN}/fit_nfw_mass mass_int.dat"
alias fitsbp="${CHANDRA_ACIS_BIN}/fit_sbp.sh"
alias fittp="${CHANDRA_ACIS_BIN}/fit_wang2012_model"
alias calclxfx="${CHANDRA_ACIS_BIN}/calc_lxfx_wrapper.sh"
alias getlxfx="${CHANDRA_ACIS_BIN}/get_lxfx_data.sh"
```


Usage
-----
See the documentations located in the ``doc`` directory,
especially the [``HOWTO_chandra_acis_analysis.txt``](doc/HOWTO_chandra_acis_analysis.txt)

NOTE: complete and detailed documentations are badly needed!


Useful Links
------------
* [CIAO](http://cxc.cfa.harvard.edu/ciao/)
* [Chandra CALDB](http://cxc.cfa.harvard.edu/ciao/download/caldb.html)
* [Chandra Data Archive](http://cda.harvard.edu/chaser/)
* [NED search by name](http://ned.ipac.caltech.edu/forms/byname.html)
* [NED search near position](https://ned.ipac.caltech.edu/forms/nearposn.html)
* [SIMBAD](http://simbad.u-strasbg.fr/simbad/)
* [HEASoft](https://heasarc.gsfc.nasa.gov/lheasoft/)
* [XSPEC](https://heasarc.gsfc.nasa.gov/lheasoft/xanadu/xspec/index.html)
* [QDP/PLT User's Guide](https://heasarc.gsfc.nasa.gov/ftools/others/qdp/qdp.html)
* [FTOOLS](https://heasarc.gsfc.nasa.gov/ftools/)
* [HEASARC nH tool](https://heasarc.gsfc.nasa.gov/cgi-bin/Tools/w3nh/w3nh.pl)


License
-------
Unless otherwise declared:

* Codes developed by us are distributed under the
  [MIT License](https://opensource.org/licenses/MIT);
* Documentations and products generated by us are distributed under the
  [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/us/deed.en_US).