Add README.md for mass_profile tools

1 files changed, 32 insertions, 0 deletions

diff --git a/mass_profile/README.md b/mass_profile/README.md
new file mode 100644
index 0000000..5ebb421
--- /dev/null
+++ b/mass_profile/README.md
@@ -0,0 +1,32 @@
+Mass Profile Calculation Tools
+==============================
+
+Junhua GU, Weitian LI, Zhenghao ZHU
+
+
+Introduction
+------------
+This directory contains the tools/scripts used to calculate the mass profile
+for our big Chandra ACIS sample of galaxy groups and clusters.
+
+
+NOTE
+----
+* mass calculation references:
+  + Walker et al. 2012, MNRAS, 422, 3503-3515
+    [ADS:2012MNRAS.422.3503W](http://adsabs.harvard.edu/abs/2012MNRAS.422.3503W)
+  + Ettori et al. 2013, Space Science Reviews, 177, 119-154
+    [ADS:2013SSRv..177..119E](http://adsabs.harvard.edu/abs/2013SSRv..177..119E)
+* Errors are calculated at 68% confident level.
+* NFW profile is employed to extrapolate the mass profile.
+* We use a self-proposed model (i.e., *wang2012* model) to describe/fit the gas
+  temperature profile.
+* The single-beta and double-beta models (with a constant background) are used
+  to describe the gas density profile.
+
+
+TODO
+----
+* to merge the scripts/tools for single-beta and double-beta SBP models
+  (to reduce code duplications)
+