Metadata-Version: 2.1
Name: reddutils_test
Version: 1.0.0
Summary: Small package for personal use
Author: ReddTea
Author-email: redd@tea.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Reddutils

This is ReddTea's small package compiling useful self-made functions for an astrophysical context.

# Overview
Reddutils contains many functions and classes for personal use.
Some of them may be of use for the community.

# Dependencies

This code makes use of:
  - Numpy
  - pandas
  - Scipy
  - PyAstronomy (http://www.hs.uni-hamburg.de/DE/Ins/Per/Czesla/PyA/PyA/index.html)
  - tqdm (https://pypi.python.org/pypi/tqdm)
  - tabulate
  - matplotlib.pyplot
  - ipywidgets
  - IPython.display
  
Most of them come with conda, if some are missing they can be easily installed with pip.

# Installation

In the console type in your work folder
```sh
pip install reddutils
```

# Usage

## Correlator
For a pandas dataframe or three-column table:
```sh
from reddutils import correlator as rc
import pandas as pd

df = pd.read_csv('data.csv')

cor = rc.correlator()
cor.display(df)
```

## Exodus
Use for visualising the NASA Exoplanet Archive:

```sh
from reddutils import exodus

exopop = exodus.NASA_Exoplanet_Archive()
exopop.display()
```


## Fourier Transform Visualiser
For visualising fourier transforms and the nyquist limit.

```sh
from reddutils import fourier

fou = fourier.fourier()
fou.display()
```


## Periodogram
For a pandas dataframe:
```sh
from reddutils import periodogram as rp
import pandas as pd

df = pd.read_csv('data.csv')

per = rp.LSP()
per.display(df)
```



