starccato (Stellar Core Collapse GW generator)

Starccato is a fast stellar core-collapse gravitational wave generator.

Installation

pip install starccato

Training with starccato

Train the model with the following command:

starccato_train --outdir weights/ --epochs 8

From within python:

import starccato
from starccato.training import train


train(outdir="weights/", epochs=128)
starccato.generate_signals(n=10, weights_file="weights/generator_weights.pth")

Development

git clone https://github.com/tarin-e/starccato.git
cd starccato
pip install -e ".[dev]"
pre-commit install

Ensure unit tests are passing locally and on the CI!

pytest tests/

Releasing to PyPI

1. Manually change the version number in pyproject.toml (has to be higher than previous)
2. Create a tagged commit with the version number
3. Push the tag to GitHub

git tag -a v0.1.0 -m "v0.1.0"
git push origin v0.1.0