blastwave 1.0.0__tar.gz

blastwave-1.0.0/.github/workflows/black.yml

@@ -0,0 +1,23 @@
+name: Black
+
+on: [push, pull_request]
+
+jobs:
+  black:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.14
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Reformat the code with black
+        run: |
+          black . --check

blastwave-1.0.0/.github/workflows/continuous_integration.yml

@@ -0,0 +1,81 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events
+  push:
+
+  pull_request:
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    permissions:
+      # IMPORTANT: this permission is mandatory for Trusted Publishing
+      id-token: write
+
+    # Specify the python versions to test
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - uses: actions/checkout@v3
+
+      # Set up the python versions
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: install packages
+        run: |
+          pip install --editable ".[dev]"
+
+      - name: Run tests
+        env:
+          BOOM_API_USER: ${{ secrets.BOOM_API_USER }}
+          BOOM_API_PASSWORD: ${{ secrets.BOOM_API_PASSWORD }}
+        run: coverage run -m unittest discover tests
+
+      - name: Run Coveralls
+        continue-on-error: true
+        if: ${{ success() }}
+        run: |
+          coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Echo tag name
+        run: echo "Tag is ${{ github.ref }}, Tagged is ${{ startsWith(github.ref, 'refs/tags/')}}, Python Check is ${{matrix.python-version == 3.11}},  Deploy is ${{ startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.11}}"
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: Publish distribution 📦 to PyPI
+        if: ${{ startsWith(github.ref, 'refs/tags/') && success() && matrix.python-version == 3.11 && github.event_name == 'push'}}
+        uses: pypa/gh-action-pypi-publish@release/v1

blastwave-1.0.0/.github/workflows/isort.yml

@@ -0,0 +1,23 @@
+name: isort
+
+on: [push, pull_request]
+
+jobs:
+  isort:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.14
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Reformat the code with isort
+        run: |
+          isort . --check

blastwave-1.0.0/.github/workflows/mypy.yml

@@ -0,0 +1,23 @@
+name: mypy
+
+on: [push, pull_request]
+
+jobs:
+  mypy:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.14
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Run mypy
+        run: |
+          mypy blastwave --ignore-missing-imports

blastwave-1.0.0/.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: pylint
+
+on: [push, pull_request]
+
+jobs:
+  pylint:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.14
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Run pylint
+        run: |
+          pylint blastwave

blastwave-1.0.0/.gitignore

@@ -0,0 +1,223 @@
+*.idea
+*/*.DS_Store
+*/*.egg-info
+*/*.egg
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

blastwave-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+-   repo: local
+    hooks:
+    -   id: black
+        name: black
+        entry: black
+        language: system
+        types: [ python ]
+-   repo: local
+    hooks:
+      - id: isort
+        name: isort (python)
+        entry: isort
+        language: system
+        types: [ python ]
+-   repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types: [python]
+-   repo: local
+    hooks:
+      - id: autotyping
+        name: autotyping
+        entry: autotyping
+        language: system
+#        args: ["--aggressive"]
+        types: [python]
+-   repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args:
+          [
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+          ]
+        verbose: true

blastwave-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert David Stein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

blastwave-1.0.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: blastwave
+Version: 1.0.0
+Author-email: Robert Stein <rdstein@umd.edu>
+License: MIT
+Project-URL: Homepage, https://github.com/robertdstein/blastwave
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: backoff
+Requires-Dist: dotenv
+Requires-Dist: babamul
+Requires-Dist: polars
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: coveralls; extra == "dev"
+Requires-Dist: autotyping; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: tqdm; extra == "dev"
+Requires-Dist: astropy; extra == "dev"
+Dynamic: license-file
+
+# blastwave
+
+Python client for BOOM queries, similar to [penquins](https://github.com/dmitryduev/penquins).
+
+# Installation
+
+# Install blastwave with pip:
+
+The simplest way to install blastwave is via pip:
+
+```bash
+pip install blastwave
+```
+
+or, if you want to edit the code yourself:
+
+```bash
+git clone git@github.com:robertdstein/blastwave.git
+cd blastwave
+pip install -e ".[dev]"
+```
+
+# Credentials
+
+Set your credentials in the environment:
+
+```bash
+export BOOM_USERNAME="your_username"
+export BOOM_PASSWORD="your_password"
+```
+
+or by copying the `.env.example` file to `.env` and filling in your credentials there.
+
+If you want to use the parquet cache, you should also set this in the same way via env:
+
+```bash
+export BLASTWAVE_DATA_DIR="/path/to/cache/dir"
+```
+
+# Usage
+
+See example Jupyter notebooks for usage examples.

blastwave-1.0.0/README.md

@@ -0,0 +1,42 @@
+# blastwave
+
+Python client for BOOM queries, similar to [penquins](https://github.com/dmitryduev/penquins).
+
+# Installation
+
+# Install blastwave with pip:
+
+The simplest way to install blastwave is via pip:
+
+```bash
+pip install blastwave
+```
+
+or, if you want to edit the code yourself:
+
+```bash
+git clone git@github.com:robertdstein/blastwave.git
+cd blastwave
+pip install -e ".[dev]"
+```
+
+# Credentials
+
+Set your credentials in the environment:
+
+```bash
+export BOOM_USERNAME="your_username"
+export BOOM_PASSWORD="your_password"
+```
+
+or by copying the `.env.example` file to `.env` and filling in your credentials there.
+
+If you want to use the parquet cache, you should also set this in the same way via env:
+
+```bash
+export BLASTWAVE_DATA_DIR="/path/to/cache/dir"
+```
+
+# Usage
+
+See example Jupyter notebooks for usage examples.

blastwave-1.0.0/blastwave/__init__.py

@@ -0,0 +1,7 @@
+"""
+blastwave is a python client for querying BOOM
+"""
+
+from blastwave.errors import BOOMCredentialsError
+from blastwave.models import BOOMQuery, CatalogQuery, FilterQuery, Observation, Source
+from blastwave.query import BoomClient, LSSTClient, ZTFClient

blastwave-1.0.0/blastwave/errors.py

@@ -0,0 +1,9 @@
+"""
+Custom Exceptions for blastwave
+"""
+
+
+class BOOMCredentialsError(Exception):
+    """
+    Exception raised when no credentials are provided.
+    """

blastwave-1.0.0/blastwave/models/__init__.py

@@ -0,0 +1,8 @@
+"""
+Module for various models
+"""
+
+from blastwave.models.observation import Observation
+from blastwave.models.parquet import pydantic_to_arrow_schema
+from blastwave.models.query import BOOMQuery, CatalogQuery, FilterQuery
+from blastwave.models.source import Source

blastwave-1.0.0/blastwave/models/observation.py

@@ -0,0 +1,61 @@
+"""
+Observation model
+"""
+
+import logging
+from typing import Literal
+
+import numpy as np
+import pyarrow as pa
+from pydantic import BaseModel, computed_field
+
+from blastwave.models.parquet import pydantic_to_arrow_schema
+
+logger = logging.getLogger(__name__)
+
+ObsClass = Literal["alert", "fp", "ul"]
+
+
+class Observation(BaseModel):
+    """
+    Model for an observation
+    """
+
+    jd: float
+    magpsf: float
+    sigmapsf: float
+    diffmaglim: float
+    ra: float | None
+    dec: float | None
+    snr: float
+    band: str
+    survey: str
+    det_type: ObsClass = "alert"
+    isdiffpos: bool
+
+    @computed_field()
+    @property
+    def estdiffmaglim(self) -> float:
+        """
+        Estimate the difference magnitude limit based on snr and magpsf
+
+        :return:
+        """
+        return self.magpsf - 2.5 * float(np.log10(5.0 / self.snr))
+
+    @computed_field()
+    @property
+    def mjd(self) -> float:
+        """
+        Convert JD to MJD
+        """
+        return self.jd - 2400000.5
+
+    @classmethod
+    def get_arrow_schema(cls) -> pa.Schema:
+        """
+        Get arrow schema from pydantic model
+
+        :return: Arrow schema
+        """
+        return pydantic_to_arrow_schema(cls)