astro-otter 0.6.0__py3-none-any.whl

astro_otter-0.6.0.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: astro-otter
+Version: 0.6.0
+Author-email: Noah Franz <nfranz@arizona.edu>
+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.
+        
+Project-URL: Home, https://github.com/astro-otter
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Development Status :: 2 - Pre-Alpha
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2,>=1.20
+Requires-Dist: astropy>=6
+Requires-Dist: pandas
+Requires-Dist: synphot
+Requires-Dist: typing-extensions
+Requires-Dist: pyarango
+Requires-Dist: tabulate
+Requires-Dist: matplotlib
+Requires-Dist: plotly
+Requires-Dist: astroquery
+Requires-Dist: ads
+Requires-Dist: skypatrol
+Requires-Dist: fundamentals
+Requires-Dist: astro-datalab
+Requires-Dist: sparclclient
+Requires-Dist: pydantic>=2
+Requires-Dist: pyreadline3; platform_system == "Windows"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=3.0.0; extra == "docs"
+Requires-Dist: myst-parser>=0.13; extra == "docs"
+Requires-Dist: nbsphinx>=0.9.1; extra == "docs"
+Requires-Dist: sphinx-book-theme>=0.0.33; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: autodoc; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: autodoc_pydantic; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: python-semantic-release; extra == "dev"
+Dynamic: license-file
+
+# OTTER API
+### **O**pen mul**T**iwavelength **T**ransient **E**vent **R**epository
+
+A Python API for the OTTER.
+
+[actions-badge]:            https://github.com/astro-otter/otter/workflows/CI/badge.svg
+[actions-link]:             https://github.com/astro-otter/otter/actions
+[black-badge]:              https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]:               https://github.com/psf/black
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/hepfile
+[conda-link]:               https://github.com/conda-forge/hepfile-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/mattbellis/hepfile/discussions
+[gitter-badge]:             https://badges.gitter.im/https://github.com/mattbellis/hepfile/community.svg
+[gitter-link]:              https://gitter.im/https://github.com/mattbellis/hepfile/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[pypi-link]:                https://pypi.org/project/astro-otter/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/astro-otter
+[pypi-version]:             https://badge.fury.io/py/astro-otter.svg
+[rtd-badge]:                https://readthedocs.org/projects/otter/badge/?version=latest
+[rtd-link]:                 https://otter.readthedocs.io/en/latest/?badge=latest
+[sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
+[ruff-badge]:               https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
+[ruff-link]:                https://github.com/astral-sh/ruff
+[codecov-badge]:            https://codecov.io/gh/astro-otter/otter/graph/badge.svg?token=BtCerOdTc0
+[codecov-link]:             https://codecov.io/gh/astro-otter/otter
+
+[![Documentation Status](https://readthedocs.org/projects/astro-otter/badge/?version=latest)](https://astro-otter.readthedocs.io/en/latest/?badge=latest)
+[![Actions Status][actions-badge]][actions-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![Linting: Ruff][ruff-badge]][ruff-link]
+[![codecov][codecov-badge]][codecov-link]
+
+## Installation
+To install the OTTER API use
+```
+python3 -m pip install astro-otter
+```
+
+## 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 |

astro_otter-0.6.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+astro_otter-0.6.0.dist-info/licenses/LICENSE,sha256=s9IPE8A3CAMEaZpDhj4eaorpmfLYGB0mIGphq301PUY,1067
+otter/__init__.py,sha256=pvX-TN7nLVmvKpkDi89Zxe-jMfHNiVMD3zsd_bPEK9Y,535
+otter/_version.py,sha256=heI6Lp8C2IYF5xj3fj0P4LjDEWKu9zntpyyhLmbSGcQ,76
+otter/exceptions.py,sha256=3lQF4AXVTfs9VRsVePQoIrXnramsPZbUL5crvf1s9Ng,1702
+otter/schema.py,sha256=J-iI_kEEd0aHN_Hr49HFEa8W07enh1FSDbU99NwIz3Y,11240
+otter/util.py,sha256=G5M2PdtPGKpRXCqkItyXMLj6h5F3EboBBDKWMViw04k,23333
+otter/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otter/io/data_finder.py,sha256=M6kzqMyy-yhwQfxbOs2E7i_8bCcZFW4Zyf8z-6LCxNQ,38425
+otter/io/host.py,sha256=xv_SznZuvMoMVsZLqlcmlOyaqKCMZqlTQ_gkN4VBSTw,7139
+otter/io/otter.py,sha256=UDjnolrOjSqAIN-4w1--C2jfW_TQZ4pzgr_1B5dKXOc,64618
+otter/io/transient.py,sha256=UK7rWzeChN-YQHKtdbkqbc0ZNw1gP9tkx8mgSh4lsU8,56699
+otter/plotter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+otter/plotter/otter_plotter.py,sha256=HSCCLUCubSr_VffF7-_KvqB6jYWeDvSYIxCv7LPoU70,2305
+otter/plotter/plotter.py,sha256=ni4WV63wIjhMHStDmuccltaMHSaFbwwfztYpuMdYAz8,9340
+astro_otter-0.6.0.dist-info/METADATA,sha256=xWIvo_d876rG_uCQUxCxf1LGzg15ctcWdOTLefChpCE,7150
+astro_otter-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+astro_otter-0.6.0.dist-info/top_level.txt,sha256=Wth72sCwBRUk3KZGknSKvLQDMFuJk6qiaAavMDOdG5k,6
+astro_otter-0.6.0.dist-info/RECORD,,

astro_otter-0.6.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

astro_otter-0.6.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+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.

astro_otter-0.6.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+otter

otter/__init__.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+# get the version
+from ._version import __version__
+
+
+# explicitly set the package variable to ensure relative import work
+__package__ = "otter"
+
+# import important stuff
+from .io.otter import Otter
+from .io.transient import Transient
+from .io.host import Host
+from .io.data_finder import DataFinder
+from .plotter.otter_plotter import OtterPlotter
+from .plotter.plotter import plot_light_curve, plot_sed, quick_view, query_quick_view
+from . import util
+from . import schema
+from . import exceptions

otter/_version.py

@@ -0,0 +1,5 @@
+"""
+Just define the package version in one place
+"""
+
+__version__ = "0.6.0"

otter/exceptions.py

@@ -0,0 +1,74 @@
+"""
+Custom exceptions for otter
+"""
+
+from __future__ import annotations
+
+
+class FailedQueryError(ValueError):
+    """
+    Exception thrown when the users query does not return any results.
+    """
+
+    def __str__(self):
+        txt = "You're query/search did not return any results! "
+        txt += "Try again with different parameters!"
+        return txt
+
+
+class IOError(ValueError):
+    """
+    Exception thrown when the input or output argument/value is not the correct type.
+    """
+
+    pass
+
+
+class OtterLimitationError(Exception):
+    """
+    Exception thrown when the user requests something that is currently not supported
+    by the API.
+    """
+
+    def __init__(self, msg):
+        self.msg = "Current Limitation Found: " + msg
+
+    def __str__(self):
+        return self.msg
+
+
+class TransientMergeError(Exception):
+    """
+    Exception thrown when the Transient objects can not be combined as expected.
+    """
+
+    pass
+
+
+class OtterNotImplementedError(Exception):
+    """
+    Exception thrown by methods that are not yet implemented
+    """
+
+    def __str__(self):
+        return "Not yet implemented! Please consider contributing on our GitHub!"
+
+
+class MissingEnvVarError(Exception):
+    """
+    Thrown when the querying code expects an Environment variable and doesn't get one
+    """
+
+    def __init__(self, v, url=None):
+        self.v = v
+        self.url = url
+
+    def __str__(self):
+        msg = "You are missing the following environment variables:\n"
+        for vv in self.v:
+            msg += f"\t- {vv}\n"
+        msg += "Please make an account and/or set these variables!\n"
+        if self.url is not None:
+            msg += f"See: {self.url}"
+
+        return msg