Metadata-Version: 2.1
Name: progenitor-probability
Version: 1.1
Summary: 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.
Home-page: https://github.com/garrethmartin/progenitor-fractions
Author: garrethmartin
Author-email: g.martin4@herts.ac.uk
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: numpy (>=1.14)
Requires-Dist: scipy (>=1.2)



[![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
```


