tess-ephem


Nametess-ephem JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/SSDataLab/tess-ephem
SummaryWhere are Solar System objects located in TESS FFI data?
upload_time2024-08-14 19:29:01
maintainerNone
docs_urlNone
authorGeert Barentsen
requires_python<4.0,>=3.9
licenseMIT
keywords nasa tess astronomy
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            tess-ephem
==========


**Where are Solar System objects located in TESS FFI data?**

|pypi| |pytest| |black| |flake8| |mypy|

.. |pypi| image:: https://img.shields.io/pypi/v/tess-ephem
                :target: https://pypi.python.org/pypi/tess-ephem
.. |pytest| image:: https://github.com/SSDataLab/tess-ephem/workflows/pytest/badge.svg
.. |black| image:: https://github.com/SSDataLab/tess-ephem/workflows/black/badge.svg
.. |flake8| image:: https://github.com/SSDataLab/tess-ephem/workflows/flake8/badge.svg
.. |mypy| image:: https://github.com/SSDataLab/tess-ephem/workflows/mypy/badge.svg

`tess-ephem` is a user-friendly package which enables users to compute the positions of Solar System objects -- asteroids, comets, and planets --
in the data archive of NASA's TESS Space Telescope.

Installation
------------

.. code-block:: bash

    python -m pip install tess-ephem


Example use
-----------

tess-ephem allows you to search the entire archive of TESS FFI's for the presence
of a known minor planet, and obtain the result as a Pandas DataFrame. The output pixel coordinates (column and row) follow the TESS convention, with (1,1) being the middle of the pixel in the lower left corner of the FFI. For example:

.. code-block:: python

    >>> from tess_ephem import ephem
    >>> ephem("Sedna")
               sector  camera  ccd       column          row
    time                                                    
    2458437.5       5       1    4  1540.328759  1102.742761
    2458438.5       5       1    4  1542.057935  1102.906116
    2458439.5       5       1    4  1543.919678  1102.977150
    2458440.5       5       1    4  1545.806011  1103.011147
    2458441.5       5       1    4  1547.691635  1103.029184
    ...           ...     ...  ...          ...          ...
    2460254.5      71       2    4  1984.472509  1004.531966
    2460255.5      71       2    4  1984.704905  1002.716266
    2460256.5      71       2    4  1984.934016  1000.892089
    2460257.5      71       2    4  1985.160431   999.062904
    2460258.5      71       2    4  1985.376804   997.240991

    [78 rows x 5 columns]


You can also obtain the ephemeris for one or more specific times
by passing the `time` parameter:

.. code-block:: python

    >>> ephem("Sedna", time="2018-11-21 17:35:00")
                             sector  camera  ccd       column          row
    time                                                                  
    2018-11-21 17:35:00.000       5       1    4  1552.813087  1103.033716

    >>> from astropy.time import Time
    >>> ephem("Sedna", time=Time([2458441.5,2460258.5], format='jd'))
               sector  camera  ccd       column          row
    time                                                    
    2458441.5       5       1    4  1547.691635  1103.029184
    2460258.5      71       2    4  1985.376804   997.240991


Additional physical parameters can be obtained by passing the `verbose=True` parameter:

.. code-block:: python

    >>> ephem("Sedna", time="2018-11-21 17:35:00", verbose=True)
                             sector  camera  ccd       column          row  pixels_per_hour        ra      dec    vmag  sun_distance  obs_distance  phase_angle
    time                                                                                                                                                       
    2018-11-21 17:35:00.000       5       1    4  1552.813087  1103.033716         0.074053  57.06362  7.63836  20.812     84.943049     83.975854       0.1419


You can alternatively obtain the ephemeris during a specific sector by passing 
the `sector` parameter:

.. code-block:: python

    >>> ephem("Sedna", sector=70)
               sector  camera  ccd       column          row
    time                                                    
    2460208.5      70       4    2  1965.819900  1827.440280
    2460209.5      70       4    2  1966.122988  1826.880450
    2460210.5      70       4    2  1966.445615  1826.219237
    2460211.5      70       4    2  1966.792833  1825.480366
    2460212.5      70       4    2  1967.156084  1824.685065
    2460213.5      70       4    2  1967.530374  1823.844978
    2460214.5      70       4    2  1967.912846  1822.964230
    2460215.5      70       4    2  1968.300642  1822.046948
    2460216.5      70       4    2  1968.693056  1821.098583
    2460217.5      70       4    2  1969.085076  1820.121939
    2460218.5      70       4    2  1969.477787  1819.122100
    2460219.5      70       4    2  1969.865471  1818.107325
    2460220.5      70       4    2  1970.236706  1817.102989
    2460221.5      70       4    2  1970.537507  1816.171600
    2460222.5      70       4    2  1970.786337  1815.215528
    2460223.5      70       4    2  1971.057940  1814.164426
    2460224.5      70       4    2  1971.352361  1813.044830
    2460225.5      70       4    2  1971.660316  1811.874587
    2460226.5      70       4    2  1971.976449  1810.663652
    2460227.5      70       4    2  1972.300053  1809.417480
    2460228.5      70       4    2  1972.626477  1808.140569
    2460229.5      70       4    2  1972.954292  1806.834984
    2460230.5      70       4    2  1973.282790  1805.506180
    2460231.5      70       4    2  1973.609473  1804.159986
    2460232.5      70       4    2  1973.931842  1802.802230


When passing the `sector` parameter, the `time_step` is by default 1 day. 
This can be changed as follows:

    >>> ephem("Sedna", sector=70, time_step=0.1)
               sector  camera  ccd       column          row
    time                                                    
    2460207.6      70       4    2  1965.495431  1827.937212
    2460207.7      70       4    2  1965.535648  1827.878206
    2460207.8      70       4    2  1965.575019  1827.820108
    2460207.9      70       4    2  1965.613392  1827.763020
    2460208.0      70       4    2  1965.650616  1827.707041
    ...           ...     ...  ...          ...          ...
    2460233.0      70       4    2  1974.086940  1802.125478
    2460233.1      70       4    2  1974.117634  1801.990490
    2460233.2      70       4    2  1974.148118  1801.855903
    2460233.3      70       4    2  1974.178192  1801.721961
    2460233.4      70       4    2  1974.207660  1801.588906

    [259 rows x 5 columns]


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/SSDataLab/tess-ephem",
    "name": "tess-ephem",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "NASA, TESS, Astronomy",
    "author": "Geert Barentsen",
    "author_email": "hello@geert.io",
    "download_url": "https://files.pythonhosted.org/packages/6d/a2/bd5a2094ab6f40832db332b42c46c84222af66a577dc99f44353ac74e9b5/tess_ephem-0.5.0.tar.gz",
    "platform": null,
    "description": "tess-ephem\n==========\n\n\n**Where are Solar System objects located in TESS FFI data?**\n\n|pypi| |pytest| |black| |flake8| |mypy|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/tess-ephem\n                :target: https://pypi.python.org/pypi/tess-ephem\n.. |pytest| image:: https://github.com/SSDataLab/tess-ephem/workflows/pytest/badge.svg\n.. |black| image:: https://github.com/SSDataLab/tess-ephem/workflows/black/badge.svg\n.. |flake8| image:: https://github.com/SSDataLab/tess-ephem/workflows/flake8/badge.svg\n.. |mypy| image:: https://github.com/SSDataLab/tess-ephem/workflows/mypy/badge.svg\n\n`tess-ephem` is a user-friendly package which enables users to compute the positions of Solar System objects -- asteroids, comets, and planets --\nin the data archive of NASA's TESS Space Telescope.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n    python -m pip install tess-ephem\n\n\nExample use\n-----------\n\ntess-ephem allows you to search the entire archive of TESS FFI's for the presence\nof a known minor planet, and obtain the result as a Pandas DataFrame. The output pixel coordinates (column and row) follow the TESS convention, with (1,1) being the middle of the pixel in the lower left corner of the FFI. For example:\n\n.. code-block:: python\n\n    >>> from tess_ephem import ephem\n    >>> ephem(\"Sedna\")\n               sector  camera  ccd       column          row\n    time                                                    \n    2458437.5       5       1    4  1540.328759  1102.742761\n    2458438.5       5       1    4  1542.057935  1102.906116\n    2458439.5       5       1    4  1543.919678  1102.977150\n    2458440.5       5       1    4  1545.806011  1103.011147\n    2458441.5       5       1    4  1547.691635  1103.029184\n    ...           ...     ...  ...          ...          ...\n    2460254.5      71       2    4  1984.472509  1004.531966\n    2460255.5      71       2    4  1984.704905  1002.716266\n    2460256.5      71       2    4  1984.934016  1000.892089\n    2460257.5      71       2    4  1985.160431   999.062904\n    2460258.5      71       2    4  1985.376804   997.240991\n\n    [78 rows x 5 columns]\n\n\nYou can also obtain the ephemeris for one or more specific times\nby passing the `time` parameter:\n\n.. code-block:: python\n\n    >>> ephem(\"Sedna\", time=\"2018-11-21 17:35:00\")\n                             sector  camera  ccd       column          row\n    time                                                                  \n    2018-11-21 17:35:00.000       5       1    4  1552.813087  1103.033716\n\n    >>> from astropy.time import Time\n    >>> ephem(\"Sedna\", time=Time([2458441.5,2460258.5], format='jd'))\n               sector  camera  ccd       column          row\n    time                                                    \n    2458441.5       5       1    4  1547.691635  1103.029184\n    2460258.5      71       2    4  1985.376804   997.240991\n\n\nAdditional physical parameters can be obtained by passing the `verbose=True` parameter:\n\n.. code-block:: python\n\n    >>> ephem(\"Sedna\", time=\"2018-11-21 17:35:00\", verbose=True)\n                             sector  camera  ccd       column          row  pixels_per_hour        ra      dec    vmag  sun_distance  obs_distance  phase_angle\n    time                                                                                                                                                       \n    2018-11-21 17:35:00.000       5       1    4  1552.813087  1103.033716         0.074053  57.06362  7.63836  20.812     84.943049     83.975854       0.1419\n\n\nYou can alternatively obtain the ephemeris during a specific sector by passing \nthe `sector` parameter:\n\n.. code-block:: python\n\n    >>> ephem(\"Sedna\", sector=70)\n               sector  camera  ccd       column          row\n    time                                                    \n    2460208.5      70       4    2  1965.819900  1827.440280\n    2460209.5      70       4    2  1966.122988  1826.880450\n    2460210.5      70       4    2  1966.445615  1826.219237\n    2460211.5      70       4    2  1966.792833  1825.480366\n    2460212.5      70       4    2  1967.156084  1824.685065\n    2460213.5      70       4    2  1967.530374  1823.844978\n    2460214.5      70       4    2  1967.912846  1822.964230\n    2460215.5      70       4    2  1968.300642  1822.046948\n    2460216.5      70       4    2  1968.693056  1821.098583\n    2460217.5      70       4    2  1969.085076  1820.121939\n    2460218.5      70       4    2  1969.477787  1819.122100\n    2460219.5      70       4    2  1969.865471  1818.107325\n    2460220.5      70       4    2  1970.236706  1817.102989\n    2460221.5      70       4    2  1970.537507  1816.171600\n    2460222.5      70       4    2  1970.786337  1815.215528\n    2460223.5      70       4    2  1971.057940  1814.164426\n    2460224.5      70       4    2  1971.352361  1813.044830\n    2460225.5      70       4    2  1971.660316  1811.874587\n    2460226.5      70       4    2  1971.976449  1810.663652\n    2460227.5      70       4    2  1972.300053  1809.417480\n    2460228.5      70       4    2  1972.626477  1808.140569\n    2460229.5      70       4    2  1972.954292  1806.834984\n    2460230.5      70       4    2  1973.282790  1805.506180\n    2460231.5      70       4    2  1973.609473  1804.159986\n    2460232.5      70       4    2  1973.931842  1802.802230\n\n\nWhen passing the `sector` parameter, the `time_step` is by default 1 day. \nThis can be changed as follows:\n\n    >>> ephem(\"Sedna\", sector=70, time_step=0.1)\n               sector  camera  ccd       column          row\n    time                                                    \n    2460207.6      70       4    2  1965.495431  1827.937212\n    2460207.7      70       4    2  1965.535648  1827.878206\n    2460207.8      70       4    2  1965.575019  1827.820108\n    2460207.9      70       4    2  1965.613392  1827.763020\n    2460208.0      70       4    2  1965.650616  1827.707041\n    ...           ...     ...  ...          ...          ...\n    2460233.0      70       4    2  1974.086940  1802.125478\n    2460233.1      70       4    2  1974.117634  1801.990490\n    2460233.2      70       4    2  1974.148118  1801.855903\n    2460233.3      70       4    2  1974.178192  1801.721961\n    2460233.4      70       4    2  1974.207660  1801.588906\n\n    [259 rows x 5 columns]\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Where are Solar System objects located in TESS FFI data?",
    "version": "0.5.0",
    "project_urls": {
        "Homepage": "https://github.com/SSDataLab/tess-ephem",
        "Repository": "https://github.com/SSDataLab/tess-ephem"
    },
    "split_keywords": [
        "nasa",
        " tess",
        " astronomy"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2a44458a1bec3d552f4561e792b6b430611e7adb56c9a2f9872320b238662c26",
                "md5": "e3d9ac7b9ecdef650097f1848b5f217a",
                "sha256": "d97225945f10d433941e1678d0b919df57e6e71f3b570a8b946d2a241949e69f"
            },
            "downloads": -1,
            "filename": "tess_ephem-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e3d9ac7b9ecdef650097f1848b5f217a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 8111,
            "upload_time": "2024-08-14T19:28:59",
            "upload_time_iso_8601": "2024-08-14T19:28:59.980047Z",
            "url": "https://files.pythonhosted.org/packages/2a/44/458a1bec3d552f4561e792b6b430611e7adb56c9a2f9872320b238662c26/tess_ephem-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6da2bd5a2094ab6f40832db332b42c46c84222af66a577dc99f44353ac74e9b5",
                "md5": "3d44b00d484fac3f9bd408c99547be35",
                "sha256": "fd073d63ca2d31a3e708b272e8644ccd2ef6da4f59760baf1f4400b76a38283d"
            },
            "downloads": -1,
            "filename": "tess_ephem-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3d44b00d484fac3f9bd408c99547be35",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 7510,
            "upload_time": "2024-08-14T19:29:01",
            "upload_time_iso_8601": "2024-08-14T19:29:01.499882Z",
            "url": "https://files.pythonhosted.org/packages/6d/a2/bd5a2094ab6f40832db332b42c46c84222af66a577dc99f44353ac74e9b5/tess_ephem-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-14 19:29:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SSDataLab",
    "github_project": "tess-ephem",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tess-ephem"
}
        
Elapsed time: 0.72056s