Skip to main content

OTTER API

Open mulTiwavelength Transient Event Repository

A Python API for the OTTER.

Documentation Status Actions Status PyPI version Linting: Ruff codecov DOI

Installation

To install the OTTER API use

python3 -m pip install astro-otter[standard]

Developer Instructions

  1. Set the OTTER_ROOT environment variable
    export OTTER_ROOT=/path/to/where/to/clone
    
  2. Clone the relevant repos:
    git clone https://github.com/astro-otter/otter.git $OTTER_ROOT/otter
    git clone https://github.com/astro-otter/otterdb.git $OTTER_ROOT/otterdb
    git clone https://github.com/astro-otter/otter-web.git $OTTER_ROOT/otter-web
    
  3. Install the NASA ADS Python API by following the instructions at https://ads.readthedocs.io/en/latest/#getting-started
  4. Install otter, the API for this database. From the root directory where you installed these repos:
    cd $OTTER_ROOT/otter
    python -m pip install -e .
    
  5. Process the data to build the local copy of the database. Follow the instructions in the otterdb repo README.
  6. Easily access the data using the Otter code! In python:
import os
from otter import Otter
otter = Otter(os.path.join(os.environ['OTTER_ROOT'], 'otterdb', '.otter'))
res = otter.query(names='AT2018hyz')
print(res)

Installation from Source

To install the OTTER API from the source code use

git clone https://github.com/astro-otter/otter.git
cd otter
python -m pip install .

This will be changed into the more convenient python -m pip install astro-otter at a later date!

For developers, please also enable the pre-commit hooks using

pre-commit install

Repo Organization

Directory Contents
src/otter A pip installable API for interfacing with the OTTER database
scripts The pipeline scripts for converting unprocessed data into the OTTER JSON format
docs Documentation for the OTTER API
test Some Unit tests for the source code

Download files

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

Source Distribution

astro_otter-1.3.0.tar.gz (85.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astro_otter-1.3.0-py3-none-any.whl (67.3 kB view details)

Uploaded Python 3

File details

Details for the file astro_otter-1.3.0.tar.gz.

File metadata

  • Download URL: astro_otter-1.3.0.tar.gz
  • Upload date:
  • Size: 85.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for astro_otter-1.3.0.tar.gz
Algorithm Hash digest
SHA256 20c5e96704592f43801453f1e12c86122c207c30a63b84727bd15604c2280a30
MD5 e3d86f6dc34475b916dc832a57b6242b
BLAKE2b-256 ea47aa3d257746d72562716e791779aa1f813c1c6945c7fbdfe03e5e9d1a0518

See more details on using hashes here.

Provenance

The following attestation bundles were made for astro_otter-1.3.0.tar.gz:

Publisher: pypi-publish.yml on astro-otter/otter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file astro_otter-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: astro_otter-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 67.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for astro_otter-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 529978091cd2044785191ebf5b3b78fb4684969fe9d82b0033ef24b17e1ab578
MD5 bf15e5534ba7af1cbe55589e10f39a3c
BLAKE2b-256 d053eef8f207acec1450e23a8f36fa151d1544c826d5a3bb601708bc3067d36f

See more details on using hashes here.

Provenance

The following attestation bundles were made for astro_otter-1.3.0-py3-none-any.whl:

Publisher: pypi-publish.yml on astro-otter/otter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.5.0

2 files

1.4.0

2 files

This release

1.3.0 This release

2 files

1.2.6

2 files

1.2.5

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

0.0.2

2 files

0.0.1

2 files

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