README.md

stella is a Python package to create and train a neural network to identify stellar flares. Within stella, users can simulate flares as a training set, run a neural network, and feed in their own data to the neural network model. stella returns a probability at each data point that that data point is part of a flare or not. stella can also characterize the flares identified.

To install stella with pip:

pip install stella

Alternatively you can install the current development version of stella:

    git clone https://github.com/afeinstein20/stella
    cd stella
    python setup.py install

If your work uses the stella software, please cite Feinstein, Montet, & Ansdell (2020).

If your work discusses the flare rate of young stars in the TESS Southern Hemisphere or the details of the CNNs, please cite Feinstein et al. (AJ, 2020).

Bug Reports, Questions, & Contributions

stella is an open source project under the MIT license. The source code is available on GitHub. In case of any questions or problems, please contact us via the Git Issues. Pull requests are also welcome through the GitHub page.