Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
segasai authored Nov 1, 2024
1 parent 14da31c commit 4d769c6
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
[![Coverage Status](https://coveralls.io/repos/github/segasai/minimint/badge.svg?branch=master)](https://coveralls.io/github/segasai/minimint?branch=master)[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5610692.svg)](https://doi.org/10.5281/zenodo.5610692)


Minimint (MIni Mist INTerpolation)
# Minimint (MIni Mist INTerpolation)

Software to do simple interpolation of MIST isochrones.
# Python package to perform simple interpolation of MIST isochrones.

Author: Sergey Koposov (2020-2024) skoposov __AT__ ed __DOT__ ac __DOT__ uk

# Instructions
## Instructions

* Install minimint. You can either pip install the released version or install from github

Expand All @@ -29,35 +29,36 @@ If you need additional filters, you can specify them using the filters parameter

``` minimint.download_and_prepare(filters=['JWST','WISE','DECam', 'GALEX', 'PanSTARRS', 'SDSSugriz', 'SkyMapper','UBVRIplus'])```
Check which filters are available on the MIST website http://waps.cfa.harvard.edu/MIST/model_grids.html
This will take some time (20-30 min) and will use some space (10-30 Gb).
This will take some time (20-30 min) and will use significant disk space (10-30 Gb).

If you want to put those processed isochrone files in a location different from the site-packages folder of minimint, you can use the outp_prefix parameter of `download_and_prepare`. You then will need to either specify the location each time when you construct the interpolators or with the MINIMINT_DATA_PATH environment variable

# Usage
## Usage

In order to create an interpolator object for two filters (your can provide a list of any numbers of filters)

```ii = minimint.Interpolator(['DECam_g','DECam_r'])```

The interpolator is a callable, so you can call it on mass, log10(age), feh

``` ii(mass, logage,feh)```
``` ii(mass, logage, feh)```

This returns a dictionary with photometry, logg, logteff and logl.

You also can use the interpolator to find the maximum valid mass on the isochrone.

```ii.getMaxMass(logage, feh)```

# Examples
## Examples

See the [notebook](examples/Example.ipynb) in the examples folder

## Synthetic stellar populations
If you are interested in synthetic stellar populations you will need
the implementation of the IMF. For this you may want to use https://github.com/keflavich/imf

# Acknowledgement
## Acknowledgement

If you are using this package please cite it through zenodo
If you are using this package please cite it through zenodo link
https://doi.org/10.5281/zenodo.4002971
Also make sure you acknowledge MIST isochrones https://waps.cfa.harvard.edu/MIST/

0 comments on commit 4d769c6

Please sign in to comment.