# READ ME
## Purpose:
The purpose of this code is to find when a list of solar system objects are observable from a given observatory on Earth in order to aid proposal writing.
It will create:
* A csv of the JPL Horizons call for all the objects across the semester
* A csv summary of the median value for each night
* A pdf of nightly elevation charts and summary tables for all objects visible
* A pdf with summary charts to show how the observability and target properties change over the course of the full semester
The documentation can be found at [pyObsFind documentation](https://pyobsfind.readthedocs.io/en/latest/index.html).
## Installation
First, install the package with pip:
```bash
pip install pyobsfind
```
## How to run
This package is designed to be run from the command line.
To run the package use ``python -m obsfind.run [target_list] [start_date] [end_date] [optional args]``
For example, the most simplistic command to run the package is:
```bash
python -m obsfind.run path/to/example_targets.txt 2025-08-07 2025-08-10
```
altering the path to ``example_targets.txt`` as necessary
[](https://semaphorep.github.io/codeastro/)
[](https://doi.org/10.5281/zenodo.16754829)
[](https://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyObsFind",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "astronomy, ephemeris, asteroids, comets",
"author": "Richard Cannon, Abigail Patrick, Ottavia Truttero",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/df/b1/e7d255736dd8af3e52d2b3222fbc1aaeb6b432fade2657bffc08ad75b4db/pyobsfind-0.5.1.tar.gz",
"platform": null,
"description": "# READ ME\n\n## Purpose:\n\nThe purpose of this code is to find when a list of solar system objects are observable from a given observatory on Earth in order to aid proposal writing.\n\nIt will create:\n* A csv of the JPL Horizons call for all the objects across the semester\n* A csv summary of the median value for each night\n* A pdf of nightly elevation charts and summary tables for all objects visible\n* A pdf with summary charts to show how the observability and target properties change over the course of the full semester \n\nThe documentation can be found at [pyObsFind documentation](https://pyobsfind.readthedocs.io/en/latest/index.html).\n\n\n## Installation\n\nFirst, install the package with pip:\n\n```bash\npip install pyobsfind\n```\n\n## How to run\n\nThis package is designed to be run from the command line.\n\nTo run the package use ``python -m obsfind.run [target_list] [start_date] [end_date] [optional args]``\n\nFor example, the most simplistic command to run the package is:\n\n```bash\npython -m obsfind.run path/to/example_targets.txt 2025-08-07 2025-08-10\n```\naltering the path to ``example_targets.txt`` as necessary\n\n\n\n[](https://semaphorep.github.io/codeastro/)\n[](https://doi.org/10.5281/zenodo.16754829)\n[](https://opensource.org/licenses/MIT)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package to find when solar system objects are observable",
"version": "0.5.1",
"project_urls": null,
"split_keywords": [
"astronomy",
" ephemeris",
" asteroids",
" comets"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "692ab4af5b93233568d400b2791a85a43b1bbd866d6fac568dfb5afd80e35b8d",
"md5": "45174018159d4f294783a08a9ee1ba9c",
"sha256": "fd4df189763f17869cbbe3f5b9032ab38430429eb2faea96bb545ca01101f109"
},
"downloads": -1,
"filename": "pyobsfind-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45174018159d4f294783a08a9ee1ba9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14911,
"upload_time": "2025-08-08T14:51:12",
"upload_time_iso_8601": "2025-08-08T14:51:12.312160Z",
"url": "https://files.pythonhosted.org/packages/69/2a/b4af5b93233568d400b2791a85a43b1bbd866d6fac568dfb5afd80e35b8d/pyobsfind-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dfb1e7d255736dd8af3e52d2b3222fbc1aaeb6b432fade2657bffc08ad75b4db",
"md5": "d125f86b1b8b93d6e1154cb7e4ba4f01",
"sha256": "894f045029de6e190953591d753a53ba1d22b793ae7176ecf4d47c7587754f36"
},
"downloads": -1,
"filename": "pyobsfind-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "d125f86b1b8b93d6e1154cb7e4ba4f01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13366,
"upload_time": "2025-08-08T14:51:14",
"upload_time_iso_8601": "2025-08-08T14:51:14.906326Z",
"url": "https://files.pythonhosted.org/packages/df/b1/e7d255736dd8af3e52d2b3222fbc1aaeb6b432fade2657bffc08ad75b4db/pyobsfind-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 14:51:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyobsfind"
}
JSON