# Tris
[](https://github.com/three-body-analysis/codebase/actions?query=workflow%3Apython-package)
[](https://github.com/three-body-analysis/codebase/actions?query=workflow%3Apython-package-conda)
[](https://three-body-analysis.github.io/codebase/)
[](https://pypi.org/project/tris/)
[//]: # ([](https://pypi.org/project/tris/))
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:
<p align="center">
<img src="img/methodology.png" alt="Diagram of Algorithm"/><br>
<span>Diagram of Algorithm.</span>
</p>
Basic Guide to Codebase
-------------
[//]: # (- `data` - Contains the acquired `.fits` files that contain the light curves for all objects classified as EBs.)
[//]: # (- `logbooks` - Personal Logbooks of us determining our ideal algorithm. It uses an older version of the 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/`](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:
```bash
$ 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:
```bash
$ 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](https://stackoverflow.com/).
### 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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
After you have successfully installed Git, you can run the following command in a terminal / Command Prompt etc:
```bash
$ 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:
```bash
$ pip install poetry
```
Again, if you have any issues with `pip`, check out [here](#installing-from-pypi).
After this, you can use the following command to install this library:
```bash
$ poetry install
```
Raw data
{
"_id": null,
"home_page": "https://three-body-analysis.github.io/codebase",
"name": "tris",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "NASA,Kepler,TESS,Astronomy",
"author": "Vikram Ramanathan",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/08/db70a2cc9cbb96fa004fba4f25e63f46a25e53b73bb044a678d5290bc678/tris-0.0.1.tar.gz",
"platform": null,
"description": "# Tris\n\n[](https://github.com/three-body-analysis/codebase/actions?query=workflow%3Apython-package)\n[](https://github.com/three-body-analysis/codebase/actions?query=workflow%3Apython-package-conda)\n[](https://three-body-analysis.github.io/codebase/)\n[](https://pypi.org/project/tris/)\n\n[//]: # ([](https://pypi.org/project/tris/))\n\n\nThis repository comprises the codebase for our paper, \"An Automated Screening System for Trinary Star System Candidates\",\nthat has been submitted to _Physica Scripta_.\n\n**Tris** is an open-source tool that offers a specialized method to determine \"observed-minus-computed\" (OC) diagrams from \nastronomical flux time series data (lightcurves) obtained from NASA's Kepler and K2 missions.\n\nHere is a brief outline of the algorithm:\n\n<p align=\"center\">\n <img src=\"img/methodology.png\" alt=\"Diagram of Algorithm\"/><br>\n <span>Diagram of Algorithm.</span>\n</p>\n\nBasic Guide to Codebase\n-------------\n\n[//]: # (- `data` - Contains the acquired `.fits` files that contain the light curves for all objects classified as EBs.)\n[//]: # (- `logbooks` - Personal Logbooks of us determining our ideal algorithm. It uses an older version of the codebase.)\n- `datagen` - Contains the data generation and acquisition scheme to get the files in `data`.\n- `docs` - Contains the documentation code for the codebase.\n- `notebooks` - Notebooks to test our code and visualise them, and also to give examples of usage\n- `pipelining` - Older versions of `datagen`.\n- `old` - Older versions of `tris`. Also contains logbooks of our work.\n- `tris` - Currently contains (early-stage) versions of our improved library code that will later be deployed on PyPI.\n- `manual_classification.xlsx` - Post Algorithm Manual Classification done by us.\n\nDo note that in our codebase, you will see references to a `data/` folder. This folder contains the acquired `.fits` \nfiles that contain the light curves for all objects classified as EBs. You can install this by running \n`datagen/load.sh`.\n\nDocumentation\n-------------\n\nRead the documentation at [`https://three-body-analysis.github.io/codebase/`](https://three-body-analysis.github.io/codebase/).\n\n\nSetup and Installation\n-------------\n\n### Installing from PyPI\n\nYes, we have published `tris` on PyPI! To install `tris` and all its dependencies, the easiest method would be to use \n`pip` to query PyPI. This should, by default, be present in your Python installation. To, install run the following \ncommand in a terminal or Command Prompt / Powershell:\n\n```bash\n$ pip install tris\n```\n\nDepending on the OS, you might need to use `pip3` instead. If the command is not found, you can choose to use the\nfollowing command too:\n\n```bash\n$ python -m pip install tris\n```\n\nHere too, `python` or `pip` might be replaced with `py` or `python3` and `pip3` depending on the OS and installation \nconfiguration. If you have any issues with this, it is always helpful to consult \n[Stack Overflow](https://stackoverflow.com/).\n\n### Installing from Source\n\nTo install from source, you need to get the following:\n\n#### Git\n\nGit is needed to install this repository. This is not completely necessary as you can also install the zip file for this \nrepository and store it on a local drive manually. To install Git, follow \n[this guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).\n\nAfter you have successfully installed Git, you can run the following command in a terminal / Command Prompt etc:\n\n```bash\n$ git clone https://github.com/three-body-analysis/codebase.git\n```\n\nThis stores a copy in the folder `codebase`. You can then navigate into it using `cd codebase`.\n\n#### Poetry\n\nThis project can be used easily via a tool know as Poetry. This allows you to easily reflect edits made in the original \nsource code! To install `poetry`, you can also install it using `pip` by typing in the command as follows:\n\n```bash\n$ pip install poetry\n```\n\nAgain, if you have any issues with `pip`, check out [here](#installing-from-pypi).\n\nAfter this, you can use the following command to install this library:\n\n```bash\n$ poetry install\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "An open-source screening system for Trinary Star Candidates.",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/three-body-analysis/codebase/issues",
"Documentation": "https://three-body-analysis.github.io/codebase",
"Homepage": "https://three-body-analysis.github.io/codebase",
"Repository": "https://github.com/three-body-analysis/codebase"
},
"split_keywords": [
"nasa",
"kepler",
"tess",
"astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c886abcb9c0197f176f8a28685ec4985e4b296e753674e2d00624a58fbd20783",
"md5": "35adcd72612d32fd53db7a5dbff93c53",
"sha256": "02bbe9fc2ed5fa9bf54720536787c2070110f0bb86951d33a693328969d18bf1"
},
"downloads": -1,
"filename": "tris-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35adcd72612d32fd53db7a5dbff93c53",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9045,
"upload_time": "2023-08-18T16:03:46",
"upload_time_iso_8601": "2023-08-18T16:03:46.731180Z",
"url": "https://files.pythonhosted.org/packages/c8/86/abcb9c0197f176f8a28685ec4985e4b296e753674e2d00624a58fbd20783/tris-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2908db70a2cc9cbb96fa004fba4f25e63f46a25e53b73bb044a678d5290bc678",
"md5": "ff525d8475fa5d9c0051106dd61aed29",
"sha256": "96b703b58025ef0d661e112517dfb331fe00c1c367324fd7c519c43ada3bc96b"
},
"downloads": -1,
"filename": "tris-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ff525d8475fa5d9c0051106dd61aed29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9527,
"upload_time": "2023-08-18T16:03:48",
"upload_time_iso_8601": "2023-08-18T16:03:48.387990Z",
"url": "https://files.pythonhosted.org/packages/29/08/db70a2cc9cbb96fa004fba4f25e63f46a25e53b73bb044a678d5290bc678/tris-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-18 16:03:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "three-body-analysis",
"github_project": "codebase",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"<=",
"1.24.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.1.4"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.7"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.1"
]
]
},
{
"name": "wquantiles",
"specs": []
},
{
"name": "astropy",
"specs": [
[
">=",
"5.0"
]
]
},
{
"name": "wotan",
"specs": [
[
"==",
"1.10"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.22.0"
]
]
},
{
"name": "tqdm",
"specs": [
[
">=",
"4.25.0"
]
]
}
],
"lcname": "tris"
}
JSON
