tess-locator
============
**Where is my favorite star or galaxy in NASA's TESS Full Frame Image data set?**
|pypi| |pytest| |black| |flake8| |mypy|
.. |pypi| image:: https://img.shields.io/pypi/v/tess-locator
:target: https://pypi.python.org/pypi/tess-locator
.. |pytest| image:: https://github.com/SSDataLab/tess-locator/workflows/pytest/badge.svg
.. |black| image:: https://github.com/SSDataLab/tess-locator/workflows/black/badge.svg
.. |flake8| image:: https://github.com/SSDataLab/tess-locator/workflows/flake8/badge.svg
.. |mypy| image:: https://github.com/SSDataLab/tess-locator/workflows/mypy/badge.svg
`tess-locator` is a user-friendly package which combines the
`tess-point <https://github.com/christopherburke/tess-point>`_
and `tess-cloud <https://github.com/SSDataLab/tess-cloud>`_ packages
to enable the positions of astronomical objects in the TESS data set
to be queried in a fast and friendly way.
Installation
------------
.. code-block:: bash
python -m pip install tess-locator
Example use
-----------
Converting celestial coordinates to TESS pixel coordinates:
.. code-block:: python
>>> from tess_locator import locate
>>> locate("Alpha Cen")
List of 3 coordinates
↳[TessCoord(sector=11, camera=2, ccd=2, column=1699.1, row=1860.3, time=None)
TessCoord(sector=12, camera=2, ccd=1, column=359.9, row=1838.7, time=None)
TessCoord(sector=38, camera=2, ccd=2, column=941.1, row=1953.7, time=None)]
Obtaining pixel coordinates for a specific time:
.. code-block:: python
>>> locate("Alpha Cen", time="2019-04-28")
List of 1 coordinates
↳[TessCoord(sector=11, camera=2, ccd=2, column=1699.1, row=1860.3, time=2019-04-28 00:00:00)]
Obtaining pixel coordinates for a specific celestial coordinate:
.. code-block:: python
>>> from astropy.coordinates import SkyCoord
>>> crd = SkyCoord(ra=60, dec=70, unit='deg')
>>> locate(crd)
List of 4 coordinates
↳[TessCoord(sector=19, camera=2, ccd=2, column=355.3, row=1045.9, time=None)
TessCoord(sector=25, camera=4, ccd=4, column=1107.0, row=285.9, time=None)
TessCoord(sector=26, camera=4, ccd=3, column=317.7, row=395.9, time=None)
TessCoord(sector=52, camera=4, ccd=4, column=603.5, row=240.2, time=None)]
You can access the properties of `TessCoord` objects using standard list and attribute syntax:
.. code-block:: python
>>> crdlist = locate("Alpha Cen")
>>> crdlist[0].sector, crdlist[0].camera, crdlist[0].ccd
(11, 2, 2)
>>> crdlist[0].column, crdlist[0].row
(1699.0540739785683, 1860.2510951146114)
When you have obtained a `TessCoord` object, you can use it to obtain a list of the TESS Full Frame Images (FFIs) which covered the position.
The objects returned are provided by the `tess-cloud <https://github.com/SSDataLab/tess-cloud>`_ package.
.. code-block:: python
>>> crdlist[0].list_images()
List of 1248 images
↳[TessImage("tess2019113062933-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019113065933-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019113072933-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019113075933-s0011-2-2-0143-s_ffic.fits")
...
TessImage("tess2019140065932-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019140072932-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019140075932-s0011-2-2-0143-s_ffic.fits")
TessImage("tess2019140082932-s0011-2-2-0143-s_ffic.fits")]
Documentation
-------------
Please visit the `tutorial <https://github.com/SSDataLab/tess-locator/blob/master/docs/tutorial.ipynb>`_.
Similar packages
----------------
* `tess-point <https://github.com/christopherburke/tess-point>`_ is the package being called behind the scenes. Compared to `tess-point`, we add a user-friendly API and the ability to specify the time, which is important for moving objects.
* `astroquery.mast <https://astroquery.readthedocs.io/en/latest/mast/mast.html>`_ includes the excellent ``TesscutClass.get_sectors()`` method which queries a web API. This package provides an offline version of that service, and adds the ability to query by time.
* `tess-waldo <https://github.com/SimonJMurphy/tess-waldo>`_ lets you visualize how a target moves over the detector across sectors. It queries the ``TessCut`` service to obtain this information. This package adds the ability to create such plots offline.
Raw data
{
"_id": null,
"home_page": "https://github.com/SSDataLab/tess-locator",
"name": "tess-locator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "NASA, TESS, Astronomy",
"author": "Geert Barentsen",
"author_email": "hello@geert.io",
"download_url": "https://files.pythonhosted.org/packages/d0/0e/d104c732777df6ed1ca0df7ea2e10e9d6c03fdf85ee5ce325cf468a24a39/tess_locator-0.6.0.tar.gz",
"platform": null,
"description": "tess-locator\n============\n\n**Where is my favorite star or galaxy in NASA's TESS Full Frame Image data set?**\n\n|pypi| |pytest| |black| |flake8| |mypy|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/tess-locator\n :target: https://pypi.python.org/pypi/tess-locator\n.. |pytest| image:: https://github.com/SSDataLab/tess-locator/workflows/pytest/badge.svg\n.. |black| image:: https://github.com/SSDataLab/tess-locator/workflows/black/badge.svg\n.. |flake8| image:: https://github.com/SSDataLab/tess-locator/workflows/flake8/badge.svg\n.. |mypy| image:: https://github.com/SSDataLab/tess-locator/workflows/mypy/badge.svg\n\n\n`tess-locator` is a user-friendly package which combines the\n`tess-point <https://github.com/christopherburke/tess-point>`_\nand `tess-cloud <https://github.com/SSDataLab/tess-cloud>`_ packages\nto enable the positions of astronomical objects in the TESS data set\nto be queried in a fast and friendly way.\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n python -m pip install tess-locator\n\nExample use\n-----------\n\nConverting celestial coordinates to TESS pixel coordinates:\n\n.. code-block:: python\n\n >>> from tess_locator import locate\n >>> locate(\"Alpha Cen\")\n List of 3 coordinates\n \u21b3[TessCoord(sector=11, camera=2, ccd=2, column=1699.1, row=1860.3, time=None)\n TessCoord(sector=12, camera=2, ccd=1, column=359.9, row=1838.7, time=None)\n TessCoord(sector=38, camera=2, ccd=2, column=941.1, row=1953.7, time=None)]\n\n\nObtaining pixel coordinates for a specific time:\n\n.. code-block:: python\n\n >>> locate(\"Alpha Cen\", time=\"2019-04-28\")\n List of 1 coordinates\n \u21b3[TessCoord(sector=11, camera=2, ccd=2, column=1699.1, row=1860.3, time=2019-04-28 00:00:00)]\n\n\nObtaining pixel coordinates for a specific celestial coordinate:\n\n.. code-block:: python\n\n >>> from astropy.coordinates import SkyCoord\n >>> crd = SkyCoord(ra=60, dec=70, unit='deg')\n >>> locate(crd)\n List of 4 coordinates\n \u21b3[TessCoord(sector=19, camera=2, ccd=2, column=355.3, row=1045.9, time=None)\n TessCoord(sector=25, camera=4, ccd=4, column=1107.0, row=285.9, time=None)\n TessCoord(sector=26, camera=4, ccd=3, column=317.7, row=395.9, time=None)\n TessCoord(sector=52, camera=4, ccd=4, column=603.5, row=240.2, time=None)]\n\n\nYou can access the properties of `TessCoord` objects using standard list and attribute syntax:\n\n.. code-block:: python\n\n >>> crdlist = locate(\"Alpha Cen\")\n >>> crdlist[0].sector, crdlist[0].camera, crdlist[0].ccd\n (11, 2, 2)\n >>> crdlist[0].column, crdlist[0].row\n (1699.0540739785683, 1860.2510951146114)\n\n\nWhen you have obtained a `TessCoord` object, you can use it to obtain a list of the TESS Full Frame Images (FFIs) which covered the position.\nThe objects returned are provided by the `tess-cloud <https://github.com/SSDataLab/tess-cloud>`_ package.\n\n.. code-block:: python\n\n >>> crdlist[0].list_images()\n List of 1248 images\n \u21b3[TessImage(\"tess2019113062933-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019113065933-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019113072933-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019113075933-s0011-2-2-0143-s_ffic.fits\")\n ...\n TessImage(\"tess2019140065932-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019140072932-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019140075932-s0011-2-2-0143-s_ffic.fits\")\n TessImage(\"tess2019140082932-s0011-2-2-0143-s_ffic.fits\")]\n\n\n\nDocumentation\n-------------\n\nPlease visit the `tutorial <https://github.com/SSDataLab/tess-locator/blob/master/docs/tutorial.ipynb>`_.\n\n\nSimilar packages\n----------------\n\n* `tess-point <https://github.com/christopherburke/tess-point>`_ is the package being called behind the scenes. Compared to `tess-point`, we add a user-friendly API and the ability to specify the time, which is important for moving objects.\n* `astroquery.mast <https://astroquery.readthedocs.io/en/latest/mast/mast.html>`_ includes the excellent ``TesscutClass.get_sectors()`` method which queries a web API. This package provides an offline version of that service, and adds the ability to query by time.\n* `tess-waldo <https://github.com/SimonJMurphy/tess-waldo>`_ lets you visualize how a target moves over the detector across sectors. It queries the ``TessCut`` service to obtain this information. This package adds the ability to create such plots offline.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fast offline queries of TESS FFI positions and filenames.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/SSDataLab/tess-locator",
"Repository": "https://github.com/SSDataLab/tess-locator"
},
"split_keywords": [
"nasa",
" tess",
" astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f2cb3c9cf45d5e1f55382fd29de7c2e0b46889bd200f04027609c0ecdb6995f",
"md5": "e604d1d4e7e04353c34e2f73ff73d9ba",
"sha256": "20c0b40e46feceba10ea61e0c42bc6e48eba0523c3848ee28876baab9a0597eb"
},
"downloads": -1,
"filename": "tess_locator-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e604d1d4e7e04353c34e2f73ff73d9ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8783,
"upload_time": "2023-12-08T03:07:49",
"upload_time_iso_8601": "2023-12-08T03:07:49.492985Z",
"url": "https://files.pythonhosted.org/packages/7f/2c/b3c9cf45d5e1f55382fd29de7c2e0b46889bd200f04027609c0ecdb6995f/tess_locator-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d00ed104c732777df6ed1ca0df7ea2e10e9d6c03fdf85ee5ce325cf468a24a39",
"md5": "1b336ff3e1009ce7f7909969d7652807",
"sha256": "9260711b37a2a454740f69f6641598b76e7ff157b60fda358bd43576d3a7290c"
},
"downloads": -1,
"filename": "tess_locator-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "1b336ff3e1009ce7f7909969d7652807",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7722,
"upload_time": "2023-12-08T03:07:51",
"upload_time_iso_8601": "2023-12-08T03:07:51.285315Z",
"url": "https://files.pythonhosted.org/packages/d0/0e/d104c732777df6ed1ca0df7ea2e10e9d6c03fdf85ee5ce325cf468a24a39/tess_locator-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 03:07:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SSDataLab",
"github_project": "tess-locator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tess-locator"
}
JSON
