# TOM Toolkit
[![pypi](https://img.shields.io/pypi/v/tomtoolkit.svg)](https://pypi.python.org/pypi/tomtoolkit)
[![run-tests](https://github.com/TOMToolkit/tom_base/actions/workflows/run-tests.yml/badge.svg)](https://github.com/TOMToolkit/tom_base/actions/workflows/run-tests.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a09d330b4dca4a4a86e68755268b7da3)](https://www.codacy.com/gh/TOMToolkit/tom_base/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TOMToolkit/tom_base&utm_campaign=Badge_Grade)
[![Coverage Status](https://coveralls.io/repos/github/TOMToolkit/tom_base/badge.svg?branch=main)](https://coveralls.io/github/TOMToolkit/tom_base?branch=main)
[![Documentation Status](https://readthedocs.org/projects/tom-toolkit/badge/?version=stable)](https://tom-toolkit.readthedocs.io/en/stable/?badge=stable)
[![ASCL](https://img.shields.io/badge/ascl-2208.004-blue.svg?colorB=262255)](https://ascl.net/2208.004)
[Documentation](https://tom-toolkit.readthedocs.io/en/latest/)
![logo](tom_common/static/tom_common/img/logo-color.png)
The TOM Toolkit is a web framework for building TOMs: Target and Observation
Managers. TOMs are meant to facilitate collaborative astronomical observing
projects. A typical TOM allows its users to curate target lists, request
observations of those targets at various observatories as well as manage and
organize their data. [Read more](https://tom-toolkit.readthedocs.io/en/stable/introduction/about.html) about TOMs.
## Getting started with the TOM Toolkit
The [getting started guide](https://tom-toolkit.readthedocs.io/en/latest/introduction/getting_started.html)
will guide you through the process of setting up a TOM for the first time.
## Reporting issues/feature requests
Please use the [issue tracker](https://github.com/TOMToolkit/tom_base/issues) to
report any issues or support questions.
## Development Team
The lead developers of the TOM Toolkit are [William Lindstrom](https://lco.global/people/)
and [Joey Chatelain](https://sites.google.com/site/josephchatelain),
professional software developers with the Las Cumbres Observatory software team,
together with [Jon Nation](https://lco.global/people/), [Curtis McCully](https://lco.global/people/),
[Matt Daily](https://lco.global/people/) and [Mark Bowman](https://lco.global/people/). [Rachel Street](https://lco.global/user/rstreet/) is the project's Principle Investigator.
The TOM Toolkit is grateful for the advice and collaboration with [Andy Howell](http://www.dahowell.com/),
[Edward Gomez](https://www.zemogle.net/), Craig Pellegrino, Jamie Burke and the rest of the LCO Science team.
The [original Toolkit](https://zenodo.org/records/4437764) was developed by
Austin Riba, David Collom and William Lindstrom.
Our team very much welcome input from the community, and we are grateful to
the following people for their many contributions:
- Dan Avner, NOIRLab
- Doug Arnold, Liverpool Telescope
- Etienne Bachelet, IPAC/Caltech
- Ezequiel Contreras Martinez, UCSB
- Griffin Hosseinzadeh, University of Arizona
- Bryan Miller, Gemini Observatory
- Brendan Mills, UCSB
- Julien Peloton, Fink
## Acknowledgements
We hope you find our software useful for your research. If so, we would be grateful
if you can include a brief acknowledgement in your papers and presentations, for example
"This research made use of [The TOM Toolkit](https://tom-toolkit.readthedocs.io/)".
We would also very much appreciate you including a citation to our paper describing
the Toolkit [Street, R.A. et al., 2018, SPIE, 10707, 11](http://adsabs.harvard.edu/abs/2018SPIE10707E..11S)
(to export the BibTeX please click [here](https://ui.adsabs.harvard.edu/abs/2018SPIE10707E..11S/exportcitation)).
## Contributing to the project
If you'd like to contribute to the TOM Toolkit, first of all, thanks! Secondly, we
have a [contribution guide](https://tom-toolkit.readthedocs.io/en/stable/introduction/contributing.html) that
you might find helpful. We are particularly interested in the contribution of
observation and alert modules.
### Community Code of Conduct
We encourage developers to maintian a lively and civil discourse either on github or in our slack workspace.
Please review our [code of conduct](CODE_OF_CONDUCT.md) for information about what is considered unacceptable behavior and how to report it.
## Developer information
For development information targeted at the maintainers of the project, please see [README-dev.md](README-dev.md).
## Plugins
### tom_alerts_dash
The [tom_alerts_dash](https://github.com/TOMToolkit/tom_alerts_dash) plugin adds responsive ReactJS views to the
`tom_alerts` module for supported brokers.
### Antares
The [tom-antares](https://github.com/TOMToolkit/tom_antares) plugin adds support
for querying the Antares broker for targets of interest.
### tom_nonsidereal_airmass
The [tom_nonsidereal_airmass](https://github.com/TOMToolkit/tom_nonsidereal_airmass) plugin provides a templatetag
that supports plotting for non-sidereal objects. The plugin is fully supported by the TOM Toolkit team; however,
non-sidereal visibility calculations require the PyEphem library, which is minimally supported while its successor
is in development. The library used for the TOM Toolkit sidereal visibility, astroplan, does not yet support
non-sidereal visibility calculations.
### tom-lt
This module provides the ability to submit observations to the Liverpool Telescope Phase 2 system. It is in a very alpha
state, with little error handling and minimal instrument options, but can successfully submit well-formed observation
requests.
[Github](https://github.com/TOMToolkit/tom_lt)
### tom_registration
The [tom_registration](https://github.com/TOMToolkit/tom_registration) plugin introduces support for two TOM registration
flows--an open registration, and a registration that requires administrator approval.
## About the TOM Toolkit
The TOM Toolkit is managed by Las Cumbres Observatory, with generous
financial support from the [National Science Foundation](https://www.nsf.gov/) grant 2209852.
We are also grateful for support from the [Heising-Simons Foundation](https://hsfoundation.org)
and the [Zegar Family Foundation](https://sites.google.com/zegarff.org/site) at the start
of the project.
Raw data
{
"_id": null,
"home_page": "https://lco.global/tomtoolkit/",
"name": "tomtoolkit",
"maintainer": "William Lindstrom",
"docs_url": null,
"requires_python": "<3.13,>=3.9.0",
"maintainer_email": "llindstrom@lco.global",
"keywords": "tomtoolkit, TOM, astronomy, astrophysics, cosmology, science, fits, observatory",
"author": "TOM Toolkit Project",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0c/07/6f75563378f60c92c9ad8eb26f18e4abbc0ee15e3b5ac5a2af1cb99e6ee8/tomtoolkit-2.21.0.tar.gz",
"platform": null,
"description": "# TOM Toolkit\n[![pypi](https://img.shields.io/pypi/v/tomtoolkit.svg)](https://pypi.python.org/pypi/tomtoolkit)\n[![run-tests](https://github.com/TOMToolkit/tom_base/actions/workflows/run-tests.yml/badge.svg)](https://github.com/TOMToolkit/tom_base/actions/workflows/run-tests.yml)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a09d330b4dca4a4a86e68755268b7da3)](https://www.codacy.com/gh/TOMToolkit/tom_base/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TOMToolkit/tom_base&utm_campaign=Badge_Grade)\n[![Coverage Status](https://coveralls.io/repos/github/TOMToolkit/tom_base/badge.svg?branch=main)](https://coveralls.io/github/TOMToolkit/tom_base?branch=main)\n[![Documentation Status](https://readthedocs.org/projects/tom-toolkit/badge/?version=stable)](https://tom-toolkit.readthedocs.io/en/stable/?badge=stable)\n[![ASCL](https://img.shields.io/badge/ascl-2208.004-blue.svg?colorB=262255)](https://ascl.net/2208.004)\n\n[Documentation](https://tom-toolkit.readthedocs.io/en/latest/)\n![logo](tom_common/static/tom_common/img/logo-color.png)\n\nThe TOM Toolkit is a web framework for building TOMs: Target and Observation\nManagers. TOMs are meant to facilitate collaborative astronomical observing\nprojects. A typical TOM allows its users to curate target lists, request\nobservations of those targets at various observatories as well as manage and\norganize their data. [Read more](https://tom-toolkit.readthedocs.io/en/stable/introduction/about.html) about TOMs.\n\n## Getting started with the TOM Toolkit\nThe [getting started guide](https://tom-toolkit.readthedocs.io/en/latest/introduction/getting_started.html)\nwill guide you through the process of setting up a TOM for the first time.\n\n## Reporting issues/feature requests\nPlease use the [issue tracker](https://github.com/TOMToolkit/tom_base/issues) to\nreport any issues or support questions.\n\n## Development Team \nThe lead developers of the TOM Toolkit are [William Lindstrom](https://lco.global/people/)\nand [Joey Chatelain](https://sites.google.com/site/josephchatelain),\nprofessional software developers with the Las Cumbres Observatory software team,\ntogether with [Jon Nation](https://lco.global/people/), [Curtis McCully](https://lco.global/people/),\n[Matt Daily](https://lco.global/people/) and [Mark Bowman](https://lco.global/people/). [Rachel Street](https://lco.global/user/rstreet/) is the project's Principle Investigator.\nThe TOM Toolkit is grateful for the advice and collaboration with [Andy Howell](http://www.dahowell.com/),\n[Edward Gomez](https://www.zemogle.net/), Craig Pellegrino, Jamie Burke and the rest of the LCO Science team.\nThe [original Toolkit](https://zenodo.org/records/4437764) was developed by\nAustin Riba, David Collom and William Lindstrom.\n\nOur team very much welcome input from the community, and we are grateful to\nthe following people for their many contributions:\n - Dan Avner, NOIRLab\n - Doug Arnold, Liverpool Telescope\n - Etienne Bachelet, IPAC/Caltech\n - Ezequiel Contreras Martinez, UCSB\n - Griffin Hosseinzadeh, University of Arizona\n - Bryan Miller, Gemini Observatory\n - Brendan Mills, UCSB\n - Julien Peloton, Fink\n\n## Acknowledgements\n\nWe hope you find our software useful for your research. If so, we would be grateful\nif you can include a brief acknowledgement in your papers and presentations, for example \n\"This research made use of [The TOM Toolkit](https://tom-toolkit.readthedocs.io/)\". \nWe would also very much appreciate you including a citation to our paper describing \nthe Toolkit [Street, R.A. et al., 2018, SPIE, 10707, 11](http://adsabs.harvard.edu/abs/2018SPIE10707E..11S) \n(to export the BibTeX please click [here](https://ui.adsabs.harvard.edu/abs/2018SPIE10707E..11S/exportcitation)). \n\n\n## Contributing to the project\nIf you'd like to contribute to the TOM Toolkit, first of all, thanks! Secondly, we\nhave a [contribution guide](https://tom-toolkit.readthedocs.io/en/stable/introduction/contributing.html) that\nyou might find helpful. We are particularly interested in the contribution of\nobservation and alert modules.\n\n### Community Code of Conduct\nWe encourage developers to maintian a lively and civil discourse either on github or in our slack workspace.\nPlease review our [code of conduct](CODE_OF_CONDUCT.md) for information about what is considered unacceptable behavior and how to report it.\n\n## Developer information\nFor development information targeted at the maintainers of the project, please see [README-dev.md](README-dev.md).\n\n## Plugins\n\n### tom_alerts_dash\n\nThe [tom_alerts_dash](https://github.com/TOMToolkit/tom_alerts_dash) plugin adds responsive ReactJS views to the\n`tom_alerts` module for supported brokers.\n\n### Antares\n\nThe [tom-antares](https://github.com/TOMToolkit/tom_antares) plugin adds support\nfor querying the Antares broker for targets of interest.\n\n### tom_nonsidereal_airmass\n\nThe [tom_nonsidereal_airmass](https://github.com/TOMToolkit/tom_nonsidereal_airmass) plugin provides a templatetag\nthat supports plotting for non-sidereal objects. The plugin is fully supported by the TOM Toolkit team; however,\nnon-sidereal visibility calculations require the PyEphem library, which is minimally supported while its successor\nis in development. The library used for the TOM Toolkit sidereal visibility, astroplan, does not yet support\nnon-sidereal visibility calculations.\n\n### tom-lt\n\nThis module provides the ability to submit observations to the Liverpool Telescope Phase 2 system. It is in a very alpha\nstate, with little error handling and minimal instrument options, but can successfully submit well-formed observation\nrequests.\n\n[Github](https://github.com/TOMToolkit/tom_lt)\n\n### tom_registration\n\nThe [tom_registration](https://github.com/TOMToolkit/tom_registration) plugin introduces support for two TOM registration\nflows--an open registration, and a registration that requires administrator approval.\n\n## About the TOM Toolkit\n\nThe TOM Toolkit is managed by Las Cumbres Observatory, with generous\nfinancial support from the [National Science Foundation](https://www.nsf.gov/) grant 2209852.\nWe are also grateful for support from the [Heising-Simons Foundation](https://hsfoundation.org) \nand the [Zegar Family Foundation](https://sites.google.com/zegarff.org/site) at the start\nof the project. \n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "TOM Toolkit and base modules",
"version": "2.21.0",
"project_urls": {
"Documentation": "https://tom-toolkit.readthedocs.io/en/latest/",
"Homepage": "https://lco.global/tomtoolkit/",
"Repository": "https://github.com/TOMToolkit/tom_base"
},
"split_keywords": [
"tomtoolkit",
" tom",
" astronomy",
" astrophysics",
" cosmology",
" science",
" fits",
" observatory"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "50bc7abbbd61c3d5c1bc9875279e76c6d4ed611536906c110a390efeacd32ff1",
"md5": "df76f8d2b3e443cbe9820dfd3dd2ab4f",
"sha256": "926b92c5d5d3c3d934a1701943a9b25ca912bbe8fa8f25c323d7afc31f762e9e"
},
"downloads": -1,
"filename": "tomtoolkit-2.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df76f8d2b3e443cbe9820dfd3dd2ab4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9.0",
"size": 1358962,
"upload_time": "2024-11-08T00:19:50",
"upload_time_iso_8601": "2024-11-08T00:19:50.221570Z",
"url": "https://files.pythonhosted.org/packages/50/bc/7abbbd61c3d5c1bc9875279e76c6d4ed611536906c110a390efeacd32ff1/tomtoolkit-2.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c076f75563378f60c92c9ad8eb26f18e4abbc0ee15e3b5ac5a2af1cb99e6ee8",
"md5": "54b2fd84efcee2e562c84cb927602041",
"sha256": "24e4960dbac297fcdb6d57e1981d5941815bd5e351f0f32b61414fb67ff8eb5f"
},
"downloads": -1,
"filename": "tomtoolkit-2.21.0.tar.gz",
"has_sig": false,
"md5_digest": "54b2fd84efcee2e562c84cb927602041",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9.0",
"size": 11058586,
"upload_time": "2024-11-08T00:19:51",
"upload_time_iso_8601": "2024-11-08T00:19:51.885094Z",
"url": "https://files.pythonhosted.org/packages/0c/07/6f75563378f60c92c9ad8eb26f18e4abbc0ee15e3b5ac5a2af1cb99e6ee8/tomtoolkit-2.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 00:19:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TOMToolkit",
"github_project": "tom_base",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "tomtoolkit"
}