# deepSIP¶

deepSIP (deep learning of Supernova Ia Parameters) is an open-source toolkit for measuring the phase and light-curve shape (parameterized by SNooPy’s $$\Delta m_{15}$$) of a Type Ia Supernova (SN Ia) from an optical spectrum. The primary contents of the package are a set of three trained Convolutional Neural Networks (CNNs) for the aforementioned purposes, but tools for preprocessing spectra, modifying the neural architecture, training models, and sweeping through hyperparameters are also included.

The entire code base is available on GitHub: https://github.com/benstahl92/deepSIP

## Installation¶

First, you’ll need to clone deepSIP and enter its directory.

git clone https://github.com/benstahl92/deepSIP.git
cd deepSIP


(optional) It is recommended that you use a virtual environment for deepSIP and its dependencies.

python -m venv dsenv # create virtual environment (one time only)
source dsenv/bin/active # each time you need to activate the environment
deactivate # if/when you need to leave the environment


Install dependencies and deepSIP.

pip install -r requirements.txt
pip install .


## Standard Usage¶

from deepSIP import deepSIP
ds = deepSIP()
# spectra is a pd.DataFrame with columns including ['SN', 'filename', 'z']
predictions = ds.predict(spectra, threshold = 0.5, status = True)


Placeholder for example section on GitHub

## Full Documentation¶

Beyond standard usage, there may be occasions to use the underlying toolkit provided by deepSIP. We therefore provide full documentation of its capabilities below.

## Contributing¶

We welcome community involvement in the form of bug fixes, architecture improvements and new trained models, additional high-quality data (spectra and photometry), and expanded functionality. To those wishing to participate, we ask that you fork the deepSIP repository and issue a pull request with your changes (along with unit tests and a description of your contribution).

deepSIP is developed and maintained by Benjamin Stahl under the supervision of Prof. Alex Filippenko at UC Berkeley.