A Python API for OTTER
A Python API for OTTER - Published in JOSS (2026)
Science Score: 87.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Repository for the new TDE Catalog
Basic Info
- Host: GitHub
- Owner: astro-otter
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://astro-otter.readthedocs.io
- Size: 11.8 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
- Releases: 19
Metadata Files
README.md
OTTER API
Open mulTiwavelength Transient Event Repository
A Python API for the OTTER.
Installation
To install the OTTER API use
python3 -m pip install astro-otter
Developer Instructions
- Set the
OTTER_ROOTenvironment variableexport OTTER_ROOT=/path/to/where/to/clone - 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 - Install the NASA ADS Python API by following the instructions at https://ads.readthedocs.io/en/latest/#getting-started
- 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 . - Process the data to build the local copy of the database. Follow the instructions in the otterdb repo README.
- 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 |
Owner
- Name: astro-otter
- Login: astro-otter
- Kind: organization
- Repositories: 1
- Profile: https://github.com/astro-otter
JOSS Publication
A Python API for OTTER
GitHub Events
Total
- Release event: 7
- Delete event: 3
- Pull request event: 8
- Issues event: 22
- Issue comment event: 10
- Push event: 94
- Create event: 7
Last Year
- Release event: 7
- Delete event: 3
- Pull request event: 8
- Issues event: 20
- Issue comment event: 10
- Push event: 81
- Create event: 7
Committers
Last synced: 5 months ago
Issues and Pull Requests
Last synced: 25 days ago
All Time
- Total issues: 20
- Total pull requests: 15
- Average time to close issues: 3 months
- Average time to close pull requests: about 6 hours
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 0.55
- Average comments per pull request: 0.53
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 13
- Pull requests: 7
- Average time to close issues: 14 days
- Average time to close pull requests: 23 minutes
- Issue authors: 5
- Pull request authors: 2
- Average comments per issue: 0.23
- Average comments per pull request: 0.57
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- noahfranz13 (14)
- mitchellkarmen (3)
- mshepcode (1)
- ecd2-bit (1)
- collinchristy (1)
Pull Request Authors
- noahfranz13 (14)
- warrickball (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 500 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 19
- Total maintainers: 1
pypi.org: astro-otter
- Homepage: https://github.com/astro-otter
- Documentation: https://astro-otter.readthedocs.io/
- License: MIT License Copyright (c) 2023 Noah Franz 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.
-
Latest release: 1.0.2
published about 1 month ago
