exofop


Nameexofop JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryGeneric light curve object
upload_time2024-02-28 17:52:29
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT
keywords astronomy astrophysics time series analysis lightcurves exofop
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ExoFOP

A python-package to facilitate the download and standardization data from the Exoplanet Follow-up Observing Program (ExoFOP).
It streamlines the process of accessing ExoFOP data, making it easier for researchers and enthusiasts to work with this valuable collection of astronomical observations.

## Installation

The recommended method of installing ExoFOP is using pip:
```bash
pip install exofop
```
For more detailed installation instructions or troubleshooting, please refer to the [documentation](https://dgegen.github.io/exofop/).

## Documentation

Comprehensive documentation for ExoFOP Python package can be found [here](https://dgegen.github.io/exofop/).
It includes information about the package, installation instructions, tutorials, and API references.

## Example
Here's an example demonstrating how to use ExoFOP Python package to download and standardize data:
```python
from exofop.download import System, SystemDownloader
from exofop.extract import LightCurveTableList

# Specify the directory to store downloaded data
data_dir = "./tmp"

# Downloading Data
system = System("TOI 1130")
system_loader = SystemDownloader(
    system=system,
    data_dir=data_dir,
)

# Selecting tags and downloading them
tags = system_loader.time_series.tags
system_loader.download(tags[:5], unzip=True)

# Extracting Light Curve Data
target_dir = system_loader.target_dir
lctl = LightCurveTableList.load_exofop_data(
    target_dir=target_dir,
)
lctl.standardise_column_names()
lctl.apply_time_correction_in_case_of_discrepancy()

# Save the extracted data as a single ECSV file for future reference
lctl.save()
```
This example demonstrates how to download data for a specific target (in this case, "TOI 1130"),
extract light curve data, standardize column names, apply time corrections,
and save the extracted data for future reference.

# Contributing
Contributions to ExoFOP Python package are welcome! If you encounter any issues, have suggestions for improvements, or would like to contribute new features, please feel free to open an issue or submit a pull request on the GitHub repository.

# License
ExoFOP Python package is licensed under the MIT License. See the LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "exofop",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "astronomy,astrophysics,time series analysis,lightcurves,ExoFOP",
    "author": "",
    "author_email": "David Degen <ddegen@ethz.ch>",
    "download_url": "https://files.pythonhosted.org/packages/28/94/08d4d43507bbab8c8acadc9b2740f223299f559cd05fb342df9720ce0a14/exofop-0.0.2.tar.gz",
    "platform": null,
    "description": "# ExoFOP\n\nA python-package to facilitate the download and standardization data from the Exoplanet Follow-up Observing Program (ExoFOP).\nIt streamlines the process of accessing ExoFOP data, making it easier for researchers and enthusiasts to work with this valuable collection of astronomical observations.\n\n## Installation\n\nThe recommended method of installing ExoFOP is using pip:\n```bash\npip install exofop\n```\nFor more detailed installation instructions or troubleshooting, please refer to the [documentation](https://dgegen.github.io/exofop/).\n\n## Documentation\n\nComprehensive documentation for ExoFOP Python package can be found [here](https://dgegen.github.io/exofop/).\nIt includes information about the package, installation instructions, tutorials, and API references.\n\n## Example\nHere's an example demonstrating how to use ExoFOP Python package to download and standardize data:\n```python\nfrom exofop.download import System, SystemDownloader\nfrom exofop.extract import LightCurveTableList\n\n# Specify the directory to store downloaded data\ndata_dir = \"./tmp\"\n\n# Downloading Data\nsystem = System(\"TOI 1130\")\nsystem_loader = SystemDownloader(\n    system=system,\n    data_dir=data_dir,\n)\n\n# Selecting tags and downloading them\ntags = system_loader.time_series.tags\nsystem_loader.download(tags[:5], unzip=True)\n\n# Extracting Light Curve Data\ntarget_dir = system_loader.target_dir\nlctl = LightCurveTableList.load_exofop_data(\n    target_dir=target_dir,\n)\nlctl.standardise_column_names()\nlctl.apply_time_correction_in_case_of_discrepancy()\n\n# Save the extracted data as a single ECSV file for future reference\nlctl.save()\n```\nThis example demonstrates how to download data for a specific target (in this case, \"TOI 1130\"),\nextract light curve data, standardize column names, apply time corrections,\nand save the extracted data for future reference.\n\n# Contributing\nContributions to ExoFOP Python package are welcome! If you encounter any issues, have suggestions for improvements, or would like to contribute new features, please feel free to open an issue or submit a pull request on the GitHub repository.\n\n# License\nExoFOP Python package is licensed under the MIT License. See the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Generic light curve object",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/dgegen/exofop/issues",
        "Homepage": "https://dgegen.github.io/exofop/",
        "Source": "https://github.com/dgegen/exofop"
    },
    "split_keywords": [
        "astronomy",
        "astrophysics",
        "time series analysis",
        "lightcurves",
        "exofop"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ccb638c625bec72931c809b9bcbc9fff51d1c9c2c282386c44292d6ce2f1d3dc",
                "md5": "2c9ba8af7f9eb0dd5c626c2f5d945024",
                "sha256": "6453f3fca634b5f6b4a42cd397916f69736e7cbc96c964ce26b0aebfbd86a859"
            },
            "downloads": -1,
            "filename": "exofop-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2c9ba8af7f9eb0dd5c626c2f5d945024",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 55766,
            "upload_time": "2024-02-28T17:52:28",
            "upload_time_iso_8601": "2024-02-28T17:52:28.114751Z",
            "url": "https://files.pythonhosted.org/packages/cc/b6/38c625bec72931c809b9bcbc9fff51d1c9c2c282386c44292d6ce2f1d3dc/exofop-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "289408d4d43507bbab8c8acadc9b2740f223299f559cd05fb342df9720ce0a14",
                "md5": "99f03b6ea1312a8b6a7dcc64467940d0",
                "sha256": "87eb4fdd8899b68ba4b66ae90684e4bd6e289f477712bc6c7e11117c96a38d20"
            },
            "downloads": -1,
            "filename": "exofop-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "99f03b6ea1312a8b6a7dcc64467940d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 93912,
            "upload_time": "2024-02-28T17:52:29",
            "upload_time_iso_8601": "2024-02-28T17:52:29.221132Z",
            "url": "https://files.pythonhosted.org/packages/28/94/08d4d43507bbab8c8acadc9b2740f223299f559cd05fb342df9720ce0a14/exofop-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-28 17:52:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dgegen",
    "github_project": "exofop",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "exofop"
}
        
Elapsed time: 0.19383s