Metadata-Version: 2.1
Name: ullyses_utils
Version: 2.1.0
Summary: ULLYSES utility files and scripts
Author-email: ULLYSES STScI Team <ullyses_dp@stsci.edu>
Keywords: astronomy,jwst,simulations
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# ullyses-utils

## About

This repository contains utility scripts and data files for use in the ULLYSES program.

## Installation

To use the utility scripts and files in this repository, simply install with pip:
```
pip install ullyses-utils
```

## Usage

To use the utility scripts, the module need only be imported and run:
```
from ullyses_utils import ullyses_config
```

To use the utility data files, the package should be imported and then relative paths can be determined from your local installation.
For example, if you wish to reference the ULLYSES target alias file, you would do so like this:
```
import os
import ullyses_utils
local_dir = ullyses_utils.__path__[0]
alias_file = os.path.join(local_dir, "data/target_metadata/pd_all_aliases.json")
```
