Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Returns the joint progenitor probability (probability that a galaxy is a spheroid at z=0) for a given redshift, mass, environment (percentile) and star-formation rate.

Project description



[![PyPI](https://img.shields.io/pypi/v/progenitor-probability.svg)](https://pypi.python.org/pypi/progenitor-probability/) [![Python](https://img.shields.io/pypi/pyversions/progenitor-probability.svg)](https://pypi.python.org/pypi/progenitor-probability/)
## *README* for `tabulate_progenitor_probability.py`

### Reference:
[***Martin et al. 2018a***](https://doi.org/10.1093/mnras/stx3057 "Martin+18a"),
*Martin, G., Kaviraj, S., Devriendt J. E. G., Dubois Y., Pichon C. and Laigle C., MNRAS, 474, 3140*


### Contact:
[g.martin4@herts.ac.uk](mailto:g.martin4@herts.ac.uk "email")


### Purpose:
Reads `fractions.dat` binary file and returns the joint progenitor probability for given redshift, mass, environment (percentile) and star-formation rate (i.e. the probability that a galaxy with given properties has spheroidal morphology at z=0). If one or more dimensions are not specified, the joint progenitor probability is returned with missing dimensions marginalised out.


### Prerequisites:
* `fractions.dat`
* numpy
* scipy

### Installation:

pip install progenitor-probability


### Usage:

#### Using the built-in script:

```
tabulate_progenitor_probability.py -z 0.4 -m 10.8
0.266751184855
```
```
tabulate_progenitor_probability.py --help

usage: tabulate_progenitor_probability.py [-h] [-z REDSHIFT] [-m MASS]
[-p DENSITY] [-s SFR]

optional arguments:
-h, --help show this help message and exit
-z REDSHIFT, --redshift REDSHIFT
Redshift
-m MASS, --mass MASS Log10 stellar mass/M_sun
-p DENSITY, --density DENSITY
Local number density percentile [0,100]
-s SFR, --SFR SFR SFR in M_sun/yr
```

**-z** *redshift*

**-m** *log<sub>10</sub>(stellar mass / M<sub>sun</sub>)*

**-p** *percentile of local number density* in the range [0,100] (see [Martin et al. 2018a](https://doi.org/10.1093/mnras/stx3057 "Martin+18a"))

**-s** *star formation rate in M<sub>sun</sub>/yr*

#### Importing the package

```
from progenitor_probability import progenitor_probability
>>> progenitor_probability(redshift=0.4, mass=10.8)
0.266751184855
```


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for progenitor-probability, version 1.1
Filename, size File type Python version Upload date Hashes
Filename, size progenitor_probability-1.1-py2.py3-none-any.whl (340.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size progenitor_probability-1.1.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page