Metadata-Version: 2.1
Name: EightBitTransit
Version: 2.0.7
Summary: Shadow imaging of transiting objects
Home-page: https://github.com/d-giles/EightBitTransitGPU
Author: Daniel Giles (Orig. Emily Sandford)
Author-email: daniel.k.giles@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: imageio
Requires-Dist: numba
Requires-Dist: jupyterlab

# README #

This version of `EightBitTransit` is an MIT-licensed python code redesigned to make use of GPU parallelization with Numba:
1. Can calculate the light curve of any pixelated image transiting a star;
2. Can invert a light curve to recover the "shadow image" that produced it.

# Installation #

To install EightBitTransit, download this directory, navigate to it, and run:

`pip install .`

# Dependencies #
* Numpy
* Scipy
* Numba
* imageio
* itertools
* matplotlib
  
Optionally (for the example notebook):
* jupyterlab

# Examples #

See `./examples/examples-gpu.ipynb` for examples of both the forward and inverse shadow imaging problem, including for dip 5 of Boyajian's Star. This code reproduces figure 12 of Sandford & Kipping 2018 (https://arxiv.org/abs/1812.01618).

# Note on memory #

Repeated TransitingImage() calls can cause python to run out of memory in certain cases (thanks to textadactyl for pointing this out!)--when you are done with a TransitingImage object, deallocate it explicitly, i.e.:

`ti = TransitingImage(...)`

*some operations on ti, etc.*

`ti = None`


