# Documentation
`cheope` has its own documentation and can be found [here](https://tiziano1590.github.io/cheops_analysis-package/index.html)
# Create the appropriate environment
It is suggestted to create a separate anaconda environment to proceed with the installation:
```
conda create -n cheope python==3.8 numpy scipy matplotlib pandas
```
After creating a conda environmnent called `cheope` and installed the basic libraries `numpy`, `scipy`, `matplotlib` and `pandas`, activate the environment
```
conda activate cheope
```
Before installing cheope, install `cython` and `mpi4py` using conda:
```
conda install cython mpi4py
```
# Download and Install
### Download with PyPI:
Simply:
```
pip install cheope
```
### Download from GitHub:
```
git clone https://github.com/tiziano1590/cheops_analysis_package
```
go to your local Cheope repository and install it with the following command:
```
pip install -e .
```
IMPORTANT: For the correct usage of the parallel version of pycheops.
To do so install pycheops tiziano190 repository:
```
git clone https://github.com/tiziano1590/pycheops
cd pycheops
```
switch to the parallel branch:
```
git checkout parallel
```
and install it:
```
pip install -e .
```
# Cheops
In this section we regroup all the commands inherent to the CHEOPS space mission dataset analysis. Here we include some visualisation and analysis options.
### Usage
To use it, simply digit the command:
```
cheope -i path/to/parameters/file.yml
```
### Run initial check of a dataset
Cheope will run a basic analysis of the input dataset, checking the lightcurve and providing some basic statistics about it.
The command to run the basic check is:
```
cheope -i path/to/parameters/file.yml -sc
```
### Run analysis for a Single Visit observation and model selection with Bayes Factor
Cheope can run a single visit analysis for a transit observation, compares several models with different
parameters and computes a Bayes factor for each of them, comparing them with the simple transit model without parameters.
To run Cheope in this configuration use the command:
```
cheope -i path/to/parameters/file.yml -sb
```
### Multivisit run
In this mode, if folds all the input observations and runs a multivisit analysis.
To activate the multivisit mode, run:
```
cheope -i path/to/parameters/file.yml -m
```
### User-defined light curve
`cheope` can run also user-precomputer light curves stored in an ascii file, the minimum file should have three columns with: time, flux and the error on the flux.
Once reformatted the lightcurve into a `.txt` or `.dat` file, it is possible to fit the user-defined lightcurve by using the command:
```
cheope -i path/to/parameters/file.yml -a
```
# TESS
In this section we explore the possible commands to analyise TESS-like datasets
### Run analysis for a Single Visit including also your Kepler/TESS points
A normal Single visit run, including Kepler/TESS observation.
The command is:
```
cheope -i path/to/parameters/file.yml -skt
```
# Use of Selenium
`cheope` incorporates a web-browser bot able to download all the datasets related to a particular target.
## The CHEOPS dataset
We bypass the official API (will be included in a future version) and use a human-simulated behaviour to log into the DACE platform and download the target's dataset. To download and run a preliminary check on a planetary system, run:
```
cheope -i path/to/parameters/file.yml --selenium-dace --add-single-check
```
## The TESS dataset
Here there is a list of command to check and analyse some TESS lightcurves.
### download TESS lighcurves and run preliminary check
To run the latest sectors' light curves and run a preliminary check on them:
```
cheope -i path/to/parameters/file.yml --selenium-tess --add-single-kepler-tess --download
```
### Only display the TESS' lighcurves
If you want only display the TESS' lightcurve withough running any check nor analysis, run:
```
cheope -i path/to/parameters/file.yml --selenium-tess --read-fits
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tiziano1590/cheops_analysis-package/cheope",
"name": "cheope",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "astrophysics,exoplanets,photometry,transit",
"author": "Tiziano Zingales",
"author_email": "tiziano.zingales@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e5/84/4d215abdecce976e5dea7b7e549b3011afffc9b5b88cd6c37abd2048773d/cheope-0.6.0.tar.gz",
"platform": null,
"description": "# Documentation\n\n`cheope` has its own documentation and can be found [here](https://tiziano1590.github.io/cheops_analysis-package/index.html)\n\n# Create the appropriate environment\n\nIt is suggestted to create a separate anaconda environment to proceed with the installation:\n\n```\nconda create -n cheope python==3.8 numpy scipy matplotlib pandas\n```\n\nAfter creating a conda environmnent called `cheope` and installed the basic libraries `numpy`, `scipy`, `matplotlib` and `pandas`, activate the environment\n\n```\nconda activate cheope\n```\n\nBefore installing cheope, install `cython` and `mpi4py` using conda:\n\n```\nconda install cython mpi4py\n```\n\n# Download and Install\n\n### Download with PyPI:\n\nSimply:\n\n```\npip install cheope\n```\n\n### Download from GitHub:\n\n```\ngit clone https://github.com/tiziano1590/cheops_analysis_package\n```\n\ngo to your local Cheope repository and install it with the following command:\n\n```\npip install -e .\n```\n\nIMPORTANT: For the correct usage of the parallel version of pycheops.\nTo do so install pycheops tiziano190 repository:\n\n```\ngit clone https://github.com/tiziano1590/pycheops\n\ncd pycheops\n```\n\nswitch to the parallel branch:\n\n```\ngit checkout parallel\n```\n\nand install it:\n\n```\npip install -e .\n```\n\n# Cheops\n\nIn this section we regroup all the commands inherent to the CHEOPS space mission dataset analysis. Here we include some visualisation and analysis options.\n\n### Usage\n\nTo use it, simply digit the command:\n\n```\ncheope -i path/to/parameters/file.yml\n```\n\n### Run initial check of a dataset\n\nCheope will run a basic analysis of the input dataset, checking the lightcurve and providing some basic statistics about it.\nThe command to run the basic check is:\n\n```\ncheope -i path/to/parameters/file.yml -sc\n```\n\n### Run analysis for a Single Visit observation and model selection with Bayes Factor\n\nCheope can run a single visit analysis for a transit observation, compares several models with different\nparameters and computes a Bayes factor for each of them, comparing them with the simple transit model without parameters.\n\nTo run Cheope in this configuration use the command:\n\n```\ncheope -i path/to/parameters/file.yml -sb\n```\n\n### Multivisit run\n\nIn this mode, if folds all the input observations and runs a multivisit analysis.\nTo activate the multivisit mode, run:\n\n```\ncheope -i path/to/parameters/file.yml -m\n```\n\n### User-defined light curve\n\n`cheope` can run also user-precomputer light curves stored in an ascii file, the minimum file should have three columns with: time, flux and the error on the flux.\nOnce reformatted the lightcurve into a `.txt` or `.dat` file, it is possible to fit the user-defined lightcurve by using the command:\n\n```\ncheope -i path/to/parameters/file.yml -a\n```\n\n# TESS\n\nIn this section we explore the possible commands to analyise TESS-like datasets\n\n### Run analysis for a Single Visit including also your Kepler/TESS points\n\nA normal Single visit run, including Kepler/TESS observation.\n\nThe command is:\n\n```\ncheope -i path/to/parameters/file.yml -skt\n```\n\n# Use of Selenium\n\n`cheope` incorporates a web-browser bot able to download all the datasets related to a particular target.\n\n## The CHEOPS dataset\n\nWe bypass the official API (will be included in a future version) and use a human-simulated behaviour to log into the DACE platform and download the target's dataset. To download and run a preliminary check on a planetary system, run:\n\n```\ncheope -i path/to/parameters/file.yml --selenium-dace --add-single-check\n```\n\n## The TESS dataset\n\nHere there is a list of command to check and analyse some TESS lightcurves.\n\n### download TESS lighcurves and run preliminary check\n\nTo run the latest sectors' light curves and run a preliminary check on them:\n\n```\ncheope -i path/to/parameters/file.yml --selenium-tess --add-single-kepler-tess --download\n```\n\n### Only display the TESS' lighcurves\n\nIf you want only display the TESS' lightcurve withough running any check nor analysis, run:\n\n```\ncheope -i path/to/parameters/file.yml --selenium-tess --read-fits\n```",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "CHEOPE: studying transiting exoplanets",
"version": "0.6.0",
"split_keywords": [
"astrophysics",
"exoplanets",
"photometry",
"transit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5844d215abdecce976e5dea7b7e549b3011afffc9b5b88cd6c37abd2048773d",
"md5": "1c6f95442c09f1f621feb6cfe82868ca",
"sha256": "ca4f033e4ba30bb6e660f5cfc887f60b3adce64170e56d9677f8f7ac04b47283"
},
"downloads": -1,
"filename": "cheope-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "1c6f95442c09f1f621feb6cfe82868ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3715,
"upload_time": "2023-01-16T14:40:14",
"upload_time_iso_8601": "2023-01-16T14:40:14.119759Z",
"url": "https://files.pythonhosted.org/packages/e5/84/4d215abdecce976e5dea7b7e549b3011afffc9b5b88cd6c37abd2048773d/cheope-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-16 14:40:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "cheope"
}
JSON