# shock-cooling-curve
## Introduction
This package can be used to fit double-peaked supernova light curves using the following shock cooling emission models:
1. [PIRO 2015](https://ui.adsabs.harvard.edu/abs/2015ApJ...808L..51P/abstract)
2. [Sapir-Waxman 2017](https://ui.adsabs.harvard.edu/abs/2017ApJ...838..130S/abstract)
A) For a blue supergiant (n = 3)
B) For a red supergiant (n = 3/2)
3. [PIRO 2020](https://ui.adsabs.harvard.edu/abs/2021ApJ...909..209P/abstract)
## Package Setup
### Before installation
This package utilizes `pysynphot` in order to create synthetic photometry generated according to the analytical models
used. The user need to install `pysynphot` before installing `shock_cooling_curve` which includes downloading required
`pysynphot` files and adding them to user path.
#### `pysynphot` instructions:
Detailed instructions for how to set up `pysynphot` on your system are provided [here](https://pysynphot.readthedocs.io/en/latest/index.html#installation-and-setup).
Here is the truncated version adapted from `pysynphot` provided guidelines:
1. `pip install pysynphot`
2. Two sets of `tar` files, [1](http://ssb.stsci.edu/trds/tarfiles/synphot1.tar.gz) and [2](http://ssb.stsci.edu/trds/tarfiles/synphot2.tar.gz)
need to be downloaded and store in some local directory.
3. The terminal source file (accessible by calling `vi .zprofile` on MAC) should be opened and edited to include the
path to the `pysynphot` files set by `export PYSYN_CDBS=/my/local/dir/trds/`. Note that the variable **should** be
`PYSYN_CDBS`.
4. Check if this is done correctly by opening python in your terminal and calling the following command:
```commandline
import os
os.environ['PYSYN_CDBS']
>>> '/my/local/dir/trds/'
```
Once you have this setup, you should be good to install `shock_cooling_curve`!
### Contributing
Any code changes, suggestions or improvements are welcome and can be submitted by making a PR! To develop this code, you
can:
1. Fork this repository. It will appear in your own GitHub account as https://github.com/<your_username>/shock_cooling_curve.
2. Clone your forked `shock_cooling_curve` repository
3. `cd` into the folder `shock_cooling_curve` and `pip install -e . `
## Using this package
There are two files that have to be prepared before using this package.
1. The config file: A template for this file in provided under templates/config_template.ini. Simply make a copy of the
file and fill out all the entries in the DEFAULT section. The BOUNDS section is optional.
2. The data file: This file containing the photometry data must be a csv. The column headers and template
is under templates/phot_template.csv.
3. If you are unsure about the naming convention of filters when you include them in your photometry file, you can refer
to [filter_info.csv](https://github.com/padma18-vb/shock_cooling_curve/blob/main/templates/filter_info.csv) under templates.
Related Papers:
[The Circumstellar Environments of Double-Peaked, Calcium-strong Supernovae 2021gno and 2021inl](https://arxiv.org/abs/2203.03785)
Raw data
{
"_id": null,
"home_page": "",
"name": "shock-cooling-curve",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Padma Venkatraman <vpadma@berkeley.edu>",
"keywords": "core collapse supernovae,shock cooling emission,double peaked lightcurves,non-linear least squares fitting,MCMC sampling",
"author": "",
"author_email": "Padma Venkatraman <vpadma@berkeley.edu>, Wynn Jacabson Galan <wynnjg@berkeley.edu>",
"download_url": "https://files.pythonhosted.org/packages/df/53/40617adae649f249228386ca33c0f57fed54a33fe4e034d0c606da1d7366/shock_cooling_curve-0.0.4.tar.gz",
"platform": null,
"description": "# shock-cooling-curve\n## Introduction\nThis package can be used to fit double-peaked supernova light curves using the following shock cooling emission models:\n\n1. [PIRO 2015](https://ui.adsabs.harvard.edu/abs/2015ApJ...808L..51P/abstract)\n2. [Sapir-Waxman 2017](https://ui.adsabs.harvard.edu/abs/2017ApJ...838..130S/abstract)\n \n A) For a blue supergiant (n = 3)\n \n B) For a red supergiant (n = 3/2)\n \n3. [PIRO 2020](https://ui.adsabs.harvard.edu/abs/2021ApJ...909..209P/abstract)\n\n## Package Setup\n### Before installation\nThis package utilizes `pysynphot` in order to create synthetic photometry generated according to the analytical models \nused. The user need to install `pysynphot` before installing `shock_cooling_curve` which includes downloading required\n`pysynphot` files and adding them to user path.\n\n#### `pysynphot` instructions:\nDetailed instructions for how to set up `pysynphot` on your system are provided [here](https://pysynphot.readthedocs.io/en/latest/index.html#installation-and-setup).\nHere is the truncated version adapted from `pysynphot` provided guidelines:\n1. `pip install pysynphot`\n2. Two sets of `tar` files, [1](http://ssb.stsci.edu/trds/tarfiles/synphot1.tar.gz) and [2](http://ssb.stsci.edu/trds/tarfiles/synphot2.tar.gz)\nneed to be downloaded and store in some local directory.\n3. The terminal source file (accessible by calling `vi .zprofile` on MAC) should be opened and edited to include the\npath to the `pysynphot` files set by `export PYSYN_CDBS=/my/local/dir/trds/`. Note that the variable **should** be\n`PYSYN_CDBS`.\n4. Check if this is done correctly by opening python in your terminal and calling the following command:\n```commandline\nimport os\nos.environ['PYSYN_CDBS']\n>>> '/my/local/dir/trds/'\n```\nOnce you have this setup, you should be good to install `shock_cooling_curve`!\n\n### Contributing\nAny code changes, suggestions or improvements are welcome and can be submitted by making a PR! To develop this code, you\ncan:\n1. Fork this repository. It will appear in your own GitHub account as https://github.com/<your_username>/shock_cooling_curve.\n2. Clone your forked `shock_cooling_curve` repository\n3. `cd` into the folder `shock_cooling_curve` and `pip install -e . `\n\n## Using this package\nThere are two files that have to be prepared before using this package.\n1. The config file: A template for this file in provided under templates/config_template.ini. Simply make a copy of the\nfile and fill out all the entries in the DEFAULT section. The BOUNDS section is optional.\n \n2. The data file: This file containing the photometry data must be a csv. The column headers and template \n is under templates/phot_template.csv.\n\n3. If you are unsure about the naming convention of filters when you include them in your photometry file, you can refer\nto [filter_info.csv](https://github.com/padma18-vb/shock_cooling_curve/blob/main/templates/filter_info.csv) under templates.\n \nRelated Papers:\n[The Circumstellar Environments of Double-Peaked, Calcium-strong Supernovae 2021gno and 2021inl](https://arxiv.org/abs/2203.03785)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A python module used to model the shock cooling emission from double-peaked supernovae.",
"version": "0.0.4",
"project_urls": {
"Repository": "https://github.com/padma18-vb/shock-cooling"
},
"split_keywords": [
"core collapse supernovae",
"shock cooling emission",
"double peaked lightcurves",
"non-linear least squares fitting",
"mcmc sampling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60448569bb3166c8bc0222982586aa40c9a1441e611d983d15061d57ef4a3b4f",
"md5": "64b454ca4d287892d721925cd11fb0c3",
"sha256": "13b71187ba7c70ebb2dee0e576ae5880762ad1d65580b75b12bf8c75da904444"
},
"downloads": -1,
"filename": "shock_cooling_curve-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64b454ca4d287892d721925cd11fb0c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52822,
"upload_time": "2023-11-23T00:42:39",
"upload_time_iso_8601": "2023-11-23T00:42:39.421251Z",
"url": "https://files.pythonhosted.org/packages/60/44/8569bb3166c8bc0222982586aa40c9a1441e611d983d15061d57ef4a3b4f/shock_cooling_curve-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df5340617adae649f249228386ca33c0f57fed54a33fe4e034d0c606da1d7366",
"md5": "e0bbbffae2354e7d073aadd92d6b9196",
"sha256": "144a3f5ef7a63e0c939ee97d9abe0efd197c215e411d6bd16728c8294f07b177"
},
"downloads": -1,
"filename": "shock_cooling_curve-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "e0bbbffae2354e7d073aadd92d6b9196",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 51258,
"upload_time": "2023-11-23T00:42:44",
"upload_time_iso_8601": "2023-11-23T00:42:44.018516Z",
"url": "https://files.pythonhosted.org/packages/df/53/40617adae649f249228386ca33c0f57fed54a33fe4e034d0c606da1d7366/shock_cooling_curve-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 00:42:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "padma18-vb",
"github_project": "shock-cooling",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "shock-cooling-curve"
}
JSON
