Metadata-Version: 2.1
Name: spherinator
Version: 0.3.0
Summary: Rotation-Invariant Hyperspherical Variational Convolutional Autoencoder
Home-page: https://github.com/HITS-AIN/Spherinator
License: Apache-2.0
Author: Kai Polsterer
Author-email: kai.polsterer@h-its.org
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=6.0.0,<7.0.0)
Requires-Dist: healpy (>=1.16.6,<2.0.0)
Requires-Dist: ipykernel (>=6.27.1,<7.0.0)
Requires-Dist: jsonargparse[signatures] (>=4.27.1,<5.0.0)
Requires-Dist: lightning (>=2.1.2,<3.0.0)
Requires-Dist: matplotlib (>=3.8.2,<4.0.0)
Requires-Dist: numpy (>=1.26.2,<2.0.0)
Requires-Dist: onnx (>=1.15.0,<2.0.0)
Requires-Dist: pandas (>=2.1.3,<3.0.0)
Requires-Dist: power-spherical (>=0.8.1,<0.9.0)
Requires-Dist: psutil (>=5.9.7,<6.0.0)
Requires-Dist: scikit-image (>=0.22.0,<0.23.0)
Requires-Dist: scipy (>=1.11.4,<2.0.0)
Requires-Dist: torch (>=2.2,<3.0)
Requires-Dist: torchvision (>=0,<1)
Project-URL: Repository, https://github.com/HITS-AIN/Spherinator
Description-Content-Type: text/markdown

[![Build Status](https://github.com/HITS-AIN/Spherinator/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/HITS-AIN/Spherinator/actions/workflows/python-package.yml?branch=main)
[![Documentation Status](https://readthedocs.org/projects/spherinator/badge/?version=latest)](https://spherinator.readthedocs.io/en/latest/?badge=latest)
![versions](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)

# Spherinator & HiPSter

`Spherinator` uses [PyTorch Lightning](https://lightning.ai/docs/pytorch/stable/) to implement a convolutional neural network (CNN) based variational autoencoder (VAE) with a spherical latent space.
`HiPSter` creates the HiPS tilings and the catalog which can be visualized interactively on the surface of a sphere with [Aladin Lite](https://github.com/cds-astro/aladin-lite).

<p align="center">
  <img src="docs/assets/P404_f2.png" width="400" height="400">
</p>


## Installation

[Poetry](https://python-poetry.org/) is used for installation.

```bash
poetry install
```

## Documentation

[Read The Docs](https://spherinator.readthedocs.io/en/latest/index.html)


## Acknowledgments

Funded by the European Union. This work has received funding from the European High-Performance Computing Joint Undertaking (JU) and Belgium, Czech Republic, France, Germany, Greece, Italy, Norway, and Spain under grant agreement No 101093441.

Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European High Performance Computing Joint Undertaking (JU) and Belgium, Czech Republic, France, Germany, Greece, Italy, Norway, and Spain. Neither the European Union nor the granting authority can be held responsible for them.


## License

This project is licensed under the [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

