Metadata-Version: 2.4
Name: hyrax
Version: 0.3.2
Author-email: LINCC Frameworks <mtauraso@uw.edu>
License: MIT License
        
        Copyright (c) 2024 LINCC Frameworks
        
        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: Source Code, https://github.com/lincc-frameworks/hyrax
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: pytorch-ignite<=0.5.2
Requires-Dist: more-itertools
Requires-Dist: toml
Requires-Dist: tomlkit
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: tensorboardX
Requires-Dist: tensorboard
Requires-Dist: schwimmbad
Requires-Dist: chromadb>1.0
Requires-Dist: holoviews
Requires-Dist: bokeh
Requires-Dist: jupyter_bokeh
Requires-Dist: datashader
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: cython
Requires-Dist: mlflow
Requires-Dist: pynvml
Requires-Dist: umap-learn
Requires-Dist: pooch
Requires-Dist: onnx
Requires-Dist: onnxruntime
Requires-Dist: plotly
Requires-Dist: psutil
Requires-Dist: tqdm
Provides-Extra: examples
Provides-Extra: dev
Requires-Dist: asv==0.6.4; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-env; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# Hyrax
[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/hyrax/smoke-test.yml)](https://github.com/lincc-frameworks/hyrax/actions/workflows/smoke-test.yml)
[![codecov](https://codecov.io/gh/lincc-frameworks/hyrax/branch/main/graph/badge.svg)](https://codecov.io/gh/lincc-frameworks/hyrax)
[![Read the Docs](https://img.shields.io/readthedocs/hyrax)](https://hyrax.readthedocs.io/en/latest)
<hr>

## Introduction
Hyrax is an efficient tool
to hunt for rare and anomalous sources in large astronomical imaging surveys
(e.g., Rubin-LSST, HSC, Euclid, NGRST, etc.).
Hyrax is designed to support four primary steps in the anomaly detection workflow:

* Downloading large numbers of cutouts from public data repositories
* Building lower dimensional representations of downloaded images -- the latent space
* Interactive visualization and algorithmic exploration (e.g., clustering, similarity-search, etc.) of the latent space
* Identification & rank-ordering of potential anomalous objects

Hyrax is not tied to a specific anomaly detection algorithm/model or a specific
class of rare/anomalous objects; but rather intended to support any algorithm
that the user may want to apply on imaging data.
If the algorithm you want to use takes in tensors, outputs tensors, and can be
implemented in PyTorch; then chances are Hyrax is the right tool for you!

## Getting Started 
To get started with Hyrax, clone the repository and create a new virtual environment.
If you plan to develop code, run the ``.setup_dev.sh`` script.

```
>> git clone https://github.com/lincc-frameworks/hyrax.git
>> conda create -n hyrax python=3.10
>> bash .setup_dev.sh (Optional, for developers)
```

## Additional Information
Hyrax is under active development and has limited documentation at the moment.
We aim to have v1 stability and more documentation in the first half of 2025.
If you are an astronomer trying to use Hyrax before then, please get in touch with us!

This project started as a collaboration between different units within the
[LSST Discovery Alliance](https://lsstdiscoveryalliance.org/) --
the [LINCC Frameworks Team](https://lsstdiscoveryalliance.org/programs/lincc-frameworks/)
and LSST-DA Catalyst Fellow, [Aritra Ghosh](https://ghosharitra.com/).

## Acknowledgements

This project is supported by Schmidt Sciences.
