minimint


Nameminimint JSON
Version 0.4.1 PyPI version JSON
download
home_pagehttp://github.com/segasai/minimint
SummaryMIST Isochrone interpolation
upload_time2023-12-27 18:36:21
maintainer
docs_urlNone
authorSergey Koposov
requires_python
licenseBSD
keywords isochrone interpolation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![Build Status](https://github.com/segasai/minimint/workflows/Minimint/badge.svg)](https://github.com/segasai/minimint/actions?query=workflow%3AMinimint)
[![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)

Software to do simple interpolation of MIST isochrones.

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

# Instructions 

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

```
pip install minimint
```

* Download and prepare isochrone files 
```
minimint.download_and_prepare()
```

That will download everything and process the evolutionary tracks and bolometric corrections by creating the necessary files for the package.

`minimint.download_and_prepare()` by default creates bolometric corrections for these filters
'DECam', 'GALEX', 'PanSTARRS', 'SDSSugriz', 'SkyMapper','UBVRIplus', 'WISE'
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).

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 

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)``` 
 
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 

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

If you are using this package please cite it through zenodo
https://doi.org/10.5281/zenodo.4002971

            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/segasai/minimint",
    "name": "minimint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "isochrone interpolation",
    "author": "Sergey Koposov",
    "author_email": "skoposov@ed.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/99/90/0eaf24a94efbdd829ffcb3ab2aceabf1e6e556a5dd12f05fdc4aad3df32b/minimint-0.4.1.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://github.com/segasai/minimint/workflows/Minimint/badge.svg)](https://github.com/segasai/minimint/actions?query=workflow%3AMinimint)\n[![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)\n\n\nMinimint (MIni Mist INTerpolation)\n\nSoftware to do simple interpolation of MIST isochrones.\n\nAuthor: Sergey Koposov (2020-2021) skoposov __AT__ ed __DOT__ ac __DOT__ uk\n\n# Instructions \n\n* Install minimint. You can either pip install the released version or install from github\n\n```\npip install minimint\n```\n\n* Download and prepare isochrone files \n```\nminimint.download_and_prepare()\n```\n\nThat will download everything and process the evolutionary tracks and bolometric corrections by creating the necessary files for the package.\n\n`minimint.download_and_prepare()` by default creates bolometric corrections for these filters\n'DECam', 'GALEX', 'PanSTARRS', 'SDSSugriz', 'SkyMapper','UBVRIplus', 'WISE'\nIf you need additional filters, you can specify them using the filters parameter\n\n``` minimint.download_and_prepare(filters=['JWST','WISE','DECam', 'GALEX', 'PanSTARRS', 'SDSSugriz', 'SkyMapper','UBVRIplus'])```\nCheck which filters are available on the MIST website http://waps.cfa.harvard.edu/MIST/model_grids.html\nThis will take some time (20-30 min) and will use some space (10-30 Gb).\n\nIf 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\n\n# Usage \n\nIn order to create an interpolator object for two filters (your can provide a list of any numbers of filters)\n\n```ii = minimint.Interpolator(['DECam_g','DECam_r'])```\n\nThe interpolator is a callable, so you can call it on mass, log10(age), feh \n\n``` ii(mass, logage,feh)``` \n \nThis returns a dictionary with photometry, logg, logteff and logl.\n\nYou also can use the interpolator to find the maximum valid mass on the isochrone.\n\n```ii.getMaxMass(logage, feh)```\n\n# Examples \n\nSee the [notebook](examples/Example.ipynb) in the examples folder\n\n## Synthetic stellar populations\nIf you are interested in synthetic stellar populations you will need\nthe implementation of the IMF. For this you may want to use https://github.com/keflavich/imf\n\n# Acknowledgement\n\nIf you are using this package please cite it through zenodo\nhttps://doi.org/10.5281/zenodo.4002971\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "MIST Isochrone interpolation",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "http://github.com/segasai/minimint"
    },
    "split_keywords": [
        "isochrone",
        "interpolation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "045e19f942044beb83762534f34e8dd5d4f435f4330c9dc5241e629b9cdb9025",
                "md5": "9adc2e0a4043eede96ae796f349c33a3",
                "sha256": "42d352e3f82b81be2715ced8baa3a92dadbbe4321753f103eafb97edf85c18de"
            },
            "downloads": -1,
            "filename": "minimint-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9adc2e0a4043eede96ae796f349c33a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 13425,
            "upload_time": "2023-12-27T18:36:18",
            "upload_time_iso_8601": "2023-12-27T18:36:18.560392Z",
            "url": "https://files.pythonhosted.org/packages/04/5e/19f942044beb83762534f34e8dd5d4f435f4330c9dc5241e629b9cdb9025/minimint-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "99900eaf24a94efbdd829ffcb3ab2aceabf1e6e556a5dd12f05fdc4aad3df32b",
                "md5": "1c960042d3b1fdcde1114d4f4750ceee",
                "sha256": "25e88aa556b7e8c5154e3237d1d22dad02ff4dd9816573eae21d9de3a3847725"
            },
            "downloads": -1,
            "filename": "minimint-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1c960042d3b1fdcde1114d4f4750ceee",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 786695,
            "upload_time": "2023-12-27T18:36:21",
            "upload_time_iso_8601": "2023-12-27T18:36:21.441730Z",
            "url": "https://files.pythonhosted.org/packages/99/90/0eaf24a94efbdd829ffcb3ab2aceabf1e6e556a5dd12f05fdc4aad3df32b/minimint-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-27 18:36:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "segasai",
    "github_project": "minimint",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "minimint"
}
        
Elapsed time: 0.31341s