Skip to main content

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

Metadata

Release files for starccato 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for starccato 0.0.2
File Size Uploaded Provenance
starccato-0.0.2.tar.gz 16.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for starccato 0.0.2
File Interpreter ABI Platform
starccato-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 33.8 kB

Release files / starccato-0.0.2.tar.gz

Download URL starccato-0.0.2.tar.gz
Size 16.1 kB
Tags Source
SHA-256 checksum
How to use checksums
966dd5ce0f28b71f9efd73f9ef9a8d1aa75b0fa6d83bed13ea49de49bd9abb24
BLAKE2b-256 checksum
How to use checksums
16496acb02b2d1752cbe6c03772e088951b2d211a957b030e4fb41ef39d2a6a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / starccato-0.0.2-py3-none-any.whl

Download URL starccato-0.0.2-py3-none-any.whl
Size 17.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
39a528a73107a8e267b4145ee66a17d5ce2af8c3e5a791c6fee6b6670e5fde77
BLAKE2b-256 checksum
How to use checksums
f3a3a225c56d1ffff9bd9d2d4d01e8d5f0e1bf4344273e7a6806bb817ccae1b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for starccato 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page