Metadata-Version: 2.1
Name: swift_comet_pipeline
Version: 0.1.7
Summary: Data reduction pipeline for determining water production rates from the Swift telescope's UVOT images
License: LICENSE
Author: Shawn Oset
Requires-Python: >=3.11,<3.13
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=5.3.4)
Requires-Dist: astroquery (>=0.4.6)
Requires-Dist: comet-ice-sublimation (>=0.0.1,<0.0.2)
Requires-Dist: icecream (>=2.1.3,<3.0.0)
Requires-Dist: jupyterlab (>=4.2.5,<5.0.0)
Requires-Dist: matplotlib (>=3.8.0)
Requires-Dist: numpy (>=1.26.1)
Requires-Dist: pandas (>=2.1.1)
Requires-Dist: photutils (>=1.9.0)
Requires-Dist: pyabel (>=0.9.0,<0.10.0)
Requires-Dist: pyarrow (>=13.0.0)
Requires-Dist: pyvectorial-au (>=1.1.1,<2.0.0)
Requires-Dist: questionary (>=2.0.1,<3.0.0)
Requires-Dist: rich (>=13.6.0,<14.0.0)
Requires-Dist: sbpy (>=0.4.0,<0.5.0)
Requires-Dist: scikit-image (>=0.24.0,<0.25.0)
Requires-Dist: scikit-learn (>=1.5.2,<2.0.0)
Requires-Dist: scipy (>=1.11.3)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Requires-Dist: tqdm (>=4.66.1)
Description-Content-Type: text/markdown

# swift_comet_pipeline
A package to analyze UVOT image data of comets from the Swift satellite (https://www.swift.ac.uk/).  A related project at https://github.com/sjoset/swift_portal_downloader automates the acquisition of data appropriate for this pipeline.

## Development installation:
## Install poetry
https://www.python-poetry.org

## Create conda environment with python
```
    conda create --name env_name_here python=3.11
    conda activate env_name_here
```

## Clone this repository

## Install package locally
In the repository's directory:
```
    poetry install
```

### Configuration
Configuration is stored in a YAML file with the following entries to start a project:
```
    swift_data_path: /path/to/swift/data/
    project_path: /path/to/where/to/save/results
    jpl_horizons_id: String identifying comet that JPL Horizons can use to find comet orbital information
    vectorial_model_quality: String to select the calculation quality of the models used to determine water production: may be low, medium, high, or very_high
    vectorial_model_backend: [sbpy, rust]
```
By default the file **config.yaml** in the current directory is assumed unless specified otherwise on the command line.

An example config might look like this:
#### config.yaml
```
    swift_data_path: /Users/user/swift_data_downloads/c2013us10
    project_path: /Users/user/analysis_c2013us10
    jpl_horizons_id: C/2013 US10
    vectorial_model_quality: very_high
    vectorial_model_backend: sbpy
```

