{
    "info": {
        "author": "Joe Lyman",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python :: 3"
        ],
        "description": "pympc\n=====\n\nperform checks for the presence of minor bodies at astronomical locations for a given epoch.\n\n#### installation\n\n`pip install .`\n\nor\n\n`python setup.py install`\n\n#### examples\n\ndefine where we want the orbit catalogue to be downloaded to (see next section)\n```\n$ export MPCORB_JSON_PATH = /my/file/path/mpcorb_extended.json\n```\n\nimport the package and (optionally) grab the catalogue - this must be done at least once prior to doing any searches\nand can be run to overwrite the catalogue with the latest version from the Minor Planet Center\n```\n>>> import pympc\n>>> pympc.update_catalogue()\n```\n\n##### example 1\ndefine our search location, epoch and radius and run the check\n```\n>>> import astropy.units as u\n>>> from astropy.time import Time\n>>> ra = 230.028 * u.deg\n>>> dec = -11.774 * u.deg\n>>> epoch = Time(\"2019-01-01T00:00\")\n>>> search_radius = 0.5 * u.arcmin\n>>> max_mag = 20\n>>> pympc.minor_planet_check(ra, dec, epoch, search_radius, max_mag)\n```\n\n\n##### example 2\nhere we use float arguments, and the program assumes the units (see `pympc.minor_planet_check()` docstring)\n```\n>>> ra = 230.028  # assumed degrees\n>>> dec = -11.774  # assumed degrees\n>>> epoch = 58484.  # assumed MJD\n>>> search_radius = 30  # assumed arcseconds\n>>> max_mag = 20\n>>> pympc.minor_planet_check(ra, dec, epoch, search_radius, max_mag)\n```\n\n#### setting the orbit catalogue location\nthe location to download the MPCORB catalogue is set via the environment variable \n`MPCORB_JSON_PATH` (e.g. `export MPCORB_JSON_PATH = /my/file/path/mpcorb.json`). If this is not found the catalogue\nwill download to the default location of `/tmp/mpcorb_extended.json`.\n\n\n#### speed and multiprocessing\nthe check should take of order a second or two, depending on multiprocessing capabilities.\n\nthe private function which actually performs the calculation is `_minor_planet_check()` (note leading underscore).\nthis can be called to avoid the overhead associated with converting input arguments to `minor_planet_check()`, if\nyou can provide them directly as required (see `_minor_planet_check()` docstring).\n\nby default the program will calculate positions of bodies in the catalogue multiprocessed. to switch this off set\n`chunk_size = 0`, i.e.:\n\n```\n>>> pympc.minor_planet_check(ra, dec, epoch, search_radius, chunk_size=0)\n```\n\n#### limitations\nthe orbits are propagated by [xephem](http://www.clearskyinstitute.com/xephem), and that package does not account for\nperturbations of the orbits. thus the accuracy of the position is dependant on the time difference between the\nepoch of the orbit elements and the epoch at which the search is being performed. \nepoch differences of around a month or less should be fine for typical positional accuracies of ground-based \nobservations (~arcsecond), but time differences of several months can accrue to inaccuracies of around ~arcminute for\ncertain bodies. \n\ncurrently the epoch of the orbit elements is visible in the xephem db strings returned by `minor_planet_check()` as a\ndecimal year format (e.g. ..,2019.317808,..). some diagnostic information and warning when using large time differences\nis to be implemented.\n\nthe filtering of matches based on magnitude via `max_mag` is limited by the accuracy of the magnitude information in the\ndatabase so some buffer should be applied to the desired magnitude cutoff to allow for this.\n\n#### acknowledgments\nthis package makes use of orbit elements provided by the International Astronomical Union's [Minor Planet Center](https://www.minorplanetcenter.net).\n\nbased from a package developed by Chris Klein and Duncan Galloway",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/lyalpha/pympc",
        "keywords": "",
        "license": "GNU General Public License v3 (GPLv3)",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pympc",
        "package_url": "https://pypi.org/project/pympc/",
        "platform": "",
        "project_url": "https://pypi.org/project/pympc/",
        "project_urls": {
            "Homepage": "https://github.com/lyalpha/pympc"
        },
        "release_url": "https://pypi.org/project/pympc/0.2/",
        "requires_dist": null,
        "requires_python": ">=3.6",
        "summary": "minor planet checking",
        "version": "0.2"
    },
    "last_serial": 5923817,
    "releases": {
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "04aa40469e3e57ea043db3f044a68f2e",
                    "sha256": "651dc87563e6f9d050a8799ce2127b1c73e85217f846d06b6c49f27c07dafeff"
                },
                "downloads": -1,
                "filename": "pympc-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "04aa40469e3e57ea043db3f044a68f2e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 5485,
                "upload_time": "2019-10-03T14:32:56",
                "url": "https://files.pythonhosted.org/packages/04/ca/7a1b68207fcff9c1930d3b9e2e608e474ca5fe07d7400b7ed2716566eb09/pympc-0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "04aa40469e3e57ea043db3f044a68f2e",
                "sha256": "651dc87563e6f9d050a8799ce2127b1c73e85217f846d06b6c49f27c07dafeff"
            },
            "downloads": -1,
            "filename": "pympc-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "04aa40469e3e57ea043db3f044a68f2e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 5485,
            "upload_time": "2019-10-03T14:32:56",
            "url": "https://files.pythonhosted.org/packages/04/ca/7a1b68207fcff9c1930d3b9e2e608e474ca5fe07d7400b7ed2716566eb09/pympc-0.2.tar.gz"
        }
    ]
}