Metadata-Version: 2.2
Name: visualastro
Version: 0.1.4
Summary: Astro data analysis and plotting package
Author-email: Elko Gerville-Reache <elkogerville@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/elkogerville/VisualAstro
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: dust_extinction
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: regions
Requires-Dist: reproject
Requires-Dist: scipy
Requires-Dist: spectral_cube
Requires-Dist: specutils
Requires-Dist: tol-colors
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"

```
            /$$                            /$$                    /$$                        
           |__/                           | $$                   | $$                        
 /$$    /$$ /$$  /$$$$$$ /$$  /$$  /$$$$$ | $$  /$$$$$   /$$$$$ /$$$$$$   /$$$$$   /$$$$$$ 
|  $$  /$$/| $$ /$$____/| $$ | $$ |____ $$| $$ |____ $$ /$$___/|_  $$_/  /$$__ $$ /$$__  $$
 \  $$/$$/ | $$|  $$$$$ | $$ | $$  /$$$$$$| $$  /$$$$$$|  $$$$$  | $$   | $$ \__/| $$  \ $$
  \  $$$/  | $$ \___  $$| $$ | $$ /$$__ $$| $$ /$$__ $$ \___  $$ | $$ /$| $$     | $$  | $$
   \  $/   | $$ /$$$$$$/|  $$$$$/|  $$$$$$| $$|  $$$$$$ /$$$$$$/ |  $$$$| $$     |  $$$$$$/
    \_/    |__/|______/  \_____/  \______/|__/ \______/|______/   \___/ |__/      \______/ 
```


# VisualAstro
[![PyPI Version](https://img.shields.io/pypi/v/visualastro)](https://pypi.org/project/visualastro)
[![Tests](https://github.com/elkogerville/VisualAstro/actions/workflows/test.yml/badge.svg)](https://github.com/elkogerville/VisualAstro/actions/workflows/test.yml)

**visualastro** is an astrophysical visualization system with convenient functions for easy visualization of common astronomical data. The package is developed with ease of use in mind, and making publication ready plots.

## Installation

Currently, the most stable version of python for visualastro is version >=3.10.
To install visualastro, it is advised to create a new conda environment if possible:
```
$ conda create envname -c conda-forge python=3.14
$ conda activate envname
```
Then install the dependencies with:
```
$ conda install -c conda-forge \
    astropy dust_extinction matplotlib numpy regions reproject spectral-cube specutils scipy tqdm
```
For additional interactive functionality inside of jupyter lab:
```
$ conda install -c conda-forge ipympl ipywidgets jupyterlab
```
For classic jupyter notebook users:
```
$ conda install -c conda-forge ipympl ipywidgets notebook jupyter_server notebook-shim
```
And finally run:
```
$ pip install visualastro
```

NOTE: To ensure that interactive mode works in notebooks, first activate your conda environment and then activate jupyter notebook!

## Compatible Data
- 2D images
- 3D spectral cubes
- 1D spectra with gaussian fitting tools

## Features

- Simple, high-level wrapper functions for common astrophysical plots
- Custom matplotlib style sheets optimized for publication-quality figures
- Full compatibility with WCS, FITS

## Documentation
The full documentation can be found on github at https://github.com/elkogerville/VisualAstro

## Dependencies

VisualAstro requires:

astropy, dust_extinction, matplotlib, numpy, regions, reproject, spectral-cube, specutils, scipy, tol_colors, and tqdm.


## Credits

### Fonts
VisualAstro includes Hershey-style TrueType fonts from the smplotlib project
by Jiaxuan Li, used under the MIT License. Citation:

```
@software{jiaxuan_li_2023_8126529,
  author       = {Jiaxuan Li},
  title        = {AstroJacobLi/smplotlib: v0.0.9},
  month        = jul,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v0.0.9},
  doi          = {10.5281/zenodo.8126529},
  url          = {https://doi.org/10.5281/zenodo.8126529},
}
```
