Metadata-Version: 2.3
Name: pyarcfire
Version: 0.0.0.dev3
Summary: A port of SpArcFiRe, a spiral arc finder
Project-URL: Source, https://github.com/pavyamsiri/pyarcfire.git
Project-URL: Issues, https://github.com/pavyamsiri/pyarcfire/issues
Author: Pavadol Yamsiri
License: BSD 3-Clause License
License-File: LICENSE.txt
Keywords: arc,astronomy,finder,spiral
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Requires-Dist: numpy>=1.2
Requires-Dist: scikit-image>=0.18
Requires-Dist: scipy>=1.8
Requires-Dist: typing-extensions>=3.10
Provides-Extra: cli
Requires-Dist: matplotlib>=3.5; extra == 'cli'
Requires-Dist: pillow; extra == 'cli'
Requires-Dist: rich>=4.2.1; extra == 'cli'
Provides-Extra: test
Requires-Dist: hypothesis; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# PyArcFiRe

PyArcFiRe is a python port of [SpArcFiRe](https://github.com/waynebhayes/SpArcFiRe) which is written primarily in MatLab.
Like SpArcFiRe it can be used to detect spiral arcs in images, mostly for galaxy images however it perhaps may work in other contexts.

## Limitations

Note that this is currently a work in progress and the project may change greatly over time.

### Functionality

This port does not have all of the functionality and features of SpArcFiRe such as bar finding and fitting, automatic centering and deprojection, etc.

## Installation

You can install this package by simply using the command

```
$ pip install pyarcfire
```

## Interface

There are two main ways of using PyArcFiRe

1. As a python package to use in your own programs.
2. As a command line interface.

### Package

The main function to interface with is called `detect_spirals_in_image` which takes in a grayscale image and then performs the spiral finding algorithm.

### Command Line Interface

PyArcFiRe can also be interacted with through the command line interface via `python -m pyarcfire ...`. Currently this is a work in progress and is mainly
a way to drive debugging code.
