Skip to main content

An open-source screening system for Trinary Star Candidates.

Project description

Tris

Python Package tests status Python Package using Conda tests status Docs CI status PyPI Latest Release

This repository comprises the codebase for our paper, "An Automated Screening System for Trinary Star System Candidates", that has been submitted to Physica Scripta.

Tris is an open-source tool that offers a specialized method to determine "observed-minus-computed" (OC) diagrams from astronomical flux time series data (lightcurves) obtained from NASA's Kepler and K2 missions.

Here is a brief outline of the algorithm:

Diagram of Algorithm
Diagram of Algorithm.

Basic Guide to Codebase

  • datagen - Contains the data generation and acquisition scheme to get the files in data.
  • docs - Contains the documentation code for the codebase.
  • notebooks - Notebooks to test our code and visualise them, and also to give examples of usage
  • pipelining - Older versions of datagen.
  • old - Older versions of tris. Also contains logbooks of our work.
  • tris - Currently contains (early-stage) versions of our improved library code that will later be deployed on PyPI.
  • manual_classification.xlsx - Post Algorithm Manual Classification done by us.

Do note that in our codebase, you will see references to a data/ folder. This folder contains the acquired .fits files that contain the light curves for all objects classified as EBs. You can install this by running datagen/load.sh.

Documentation

Read the documentation at https://three-body-analysis.github.io/codebase/.

Setup and Installation

Installing from PyPI

Yes, we have published tris on PyPI! To install tris and all its dependencies, the easiest method would be to use pip to query PyPI. This should, by default, be present in your Python installation. To, install run the following command in a terminal or Command Prompt / Powershell:

$ pip install tris

Depending on the OS, you might need to use pip3 instead. If the command is not found, you can choose to use the following command too:

$ python -m pip install tris

Here too, python or pip might be replaced with py or python3 and pip3 depending on the OS and installation configuration. If you have any issues with this, it is always helpful to consult Stack Overflow.

Installing from Source

To install from source, you need to get the following:

Git

Git is needed to install this repository. This is not completely necessary as you can also install the zip file for this repository and store it on a local drive manually. To install Git, follow this guide.

After you have successfully installed Git, you can run the following command in a terminal / Command Prompt etc:

$ git clone https://github.com/three-body-analysis/codebase.git

This stores a copy in the folder codebase. You can then navigate into it using cd codebase.

Poetry

This project can be used easily via a tool know as Poetry. This allows you to easily reflect edits made in the original source code! To install poetry, you can also install it using pip by typing in the command as follows:

$ pip install poetry

Again, if you have any issues with pip, check out here.

After this, you can use the following command to install this library:

$ poetry install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tris-0.0.1.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

tris-0.0.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file tris-0.0.1.tar.gz.

File metadata

  • Download URL: tris-0.0.1.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.9.17 Windows/10

File hashes

Hashes for tris-0.0.1.tar.gz
Algorithm Hash digest
SHA256 96b703b58025ef0d661e112517dfb331fe00c1c367324fd7c519c43ada3bc96b
MD5 ff525d8475fa5d9c0051106dd61aed29
BLAKE2b-256 2908db70a2cc9cbb96fa004fba4f25e63f46a25e53b73bb044a678d5290bc678

See more details on using hashes here.

File details

Details for the file tris-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: tris-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.9.17 Windows/10

File hashes

Hashes for tris-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 02bbe9fc2ed5fa9bf54720536787c2070110f0bb86951d33a693328969d18bf1
MD5 35adcd72612d32fd53db7a5dbff93c53
BLAKE2b-256 c886abcb9c0197f176f8a28685ec4985e4b296e753674e2d00624a58fbd20783

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page