Skip to main content

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

Project description

Coverage Status Code style: black PyPi version

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starccato-0.0.2.tar.gz (16.1 kB view hashes)

Uploaded Source

Built Distribution

starccato-0.0.2-py3-none-any.whl (17.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page