{ "info": { "author": "Christian Tai Udovicic", "author_email": "cj.taiudovicic@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Scientific/Engineering :: Astronomy" ], "description": "craterpy |TravisBadge|_ |AppveyorBadge|_ |RtdBadge|_ |PyPiBadge|_ |CodecovBadge|_ |ZenodoBadge|_\r\n==============================================================================================\r\n.. |ZenodoBadge| image:: https://zenodo.org/badge/88457986.svg\r\n.. _ZenodoBadge: https://zenodo.org/badge/latestdoi/88457986\r\n\r\n.. |TravisBadge| image:: https://travis-ci.org/cjtu/craterpy.svg?branch=master\r\n.. _TravisBadge: https://travis-ci.org/cjtu/craterpy\r\n\r\n.. |AppveyorBadge| image:: https://ci.appveyor.com/api/projects/status/7r7f4lbj6kgguhtw/branch/master?svg=true\r\n.. _AppveyorBadge: https://ci.appveyor.com/project/cjtu/craterpy/branch/master\r\n\r\n.. |RtdBadge| image:: http://readthedocs.org/projects/craterpy/badge/?version=latest\r\n.. _RtdBadge: http://craterpy.readthedocs.io/en/latest/?badge=latest\r\n\r\n.. |PyPiBadge| image:: https://badge.fury.io/py/craterpy.svg\r\n.. _PyPiBadge: https://badge.fury.io/py/craterpy\r\n\r\n.. |CodecovBadge| image:: https://codecov.io/gh/cjtu/craterpy/branch/master/graph/badge.svg\r\n.. _CodecovBadge: https://codecov.io/gh/cjtu/craterpy\r\n\r\n\r\nOverview\r\n--------\r\n\r\nWelcome to **craterpy** (formerly ACERIM), your one-stop shop to crater data science in Python!\r\n\r\nPlease note: this package is in the alpha stage of development. You can direct any questions to Christian at cj.taiudovicic@gmail.com. Feature requests and bugs tracking will be hosted on the GitHub `bug tracker `_.\r\n\r\nYou can use craterpy to:\r\n\r\n - import tabular crater data into DataFrames (extends pandas),\r\n - load image data into efficient Dataset objects (extends gdal),\r\n - easily extract, mask, filter, plot, and compute stats on crater image data.\r\n\r\n\r\nExample\r\n-------\r\nA code-snippet and plot is worth a thousand words::\r\n\r\nimport pandas as pd\r\nimport craterpy as cp\r\ndf = pd.DataFrame(\"craters.csv\", index)\r\nds = cp.Dataset(\"moon.tif\")\r\nrois = cp.get_roi(ds, df[\"Crisium\"], plot_roi=True)\r\n\r\n..image:: get_roi.png\r\n\r\ncp.compute_stats(ds, df, rois).head()\r\n\r\n..image:: compute_stats.png\r\n\r\ncp.ejecta_profiles(ds, df, rois, spacing=0.1)\r\n\r\n..image:: ejecta_profiles.png\r\n\r\nNew users should start with the IPython notebook at `tutorial `_ for typical usage with examples.\r\n\r\n**Note**: While craterpy is a tool used to query image data, it does reproject it. This package **only acepts image data in simple-cylindrical (Plate Caree) projection**. Many tools exist to reproject your data. To do so in Python, we suggest checking out `GDAL `_.\r\n\r\n\r\nDependencies\r\n------------\r\n\r\ncraterpy supports python versions 2.7, 3.4 and 3.5. It depends on:\r\n\r\n - numpy\r\n - scipy\r\n - pandas\r\n - matplotlib\r\n - gdal=2.1.0\r\n\r\n\r\nQuick Installation with Anaconda\r\n--------------------------------\r\n\r\nWe reccommend the `Anaconda `_ package manager. See `Continuum Analytics `_ for installation instructions.\r\n\r\nThe following section will describe how to create and activate a conda virtual environment to run ACERIM. For more on Anaconda virtual environments, see `Managing Environments `_. \r\n\r\nWith *anaconda and gdal installed*, open a terminal window and create a new conda environment with the following command (replace **your_env_name** and choose desired python version):: \r\n\r\n conda create --name your_env_name python=3.5\r\n\r\nActivate the environment (OS X, Unix, or powershell users may need to use *source*)::\r\n\r\n (source) activate your_env_name\r\n\r\nNow install the dependencies. Ensure to specify the gdal and libgdal versions to avoid a known bug being tracked `here `_::\r\n\r\n conda install numpy scipy pandas matplotlib gdal=2.1.0 libgdal=2.1.0\r\n\r\nInstall the latest craterpy release with pip::\r\n\r\n pip install craterpy\r\n\r\nNow that you have craterpy installed, head over to the `tutorial `_ to get started!\r\n\r\n**Note**: Remember to activate your virtual environment each time you use ACERIM.\r\n\r\n\r\nForking this repository\r\n^^^^^^^^^^^^^^^^^^^^^^^\r\n\r\nYou can fork craterpy from `GitHub `_. You can then clone your forked version, navigate to the root directory and install craterpy with:\r\n\r\n::\r\n\r\n python setup.py install\r\n\r\n\r\n\r\nDocumentation\r\n-------------\r\n\r\nFull documentation is available at `readthedocs `_.\r\n\r\n\r\nSupport and Bug Reporting\r\n-------------------------\r\n\r\nBugs will be tracked at `craterpy bug tracker `_. General questions can be directed to Christian at cj.taiudovicic@gmail.com.\r\n\r\n\r\nCiting ACERIM\r\n-------------\r\n\r\nFor convenience, this project uses the OSI-certified MIT open access liscence for warranty-free ease of use and distribution. The author simply asks that you cite the project. The citable DOI can be found at Zenodo by clicking the badge below. To read more about citable code, check out `Zenodo `_.\r\n\r\n.. image:: https://zenodo.org/badge/88457986.svg\r\n :target: https://zenodo.org/badge/latestdoi/88457986\r\n\r\n\r\nContributing\r\n------------\r\n\r\ncraterpy is seeking contributers of all skill levels! Please read CONTRIBUTING.rst if you are interested in supporting craterpy. Feel free to check the bug tracker for open issues or get in touch with Christian at cj.taiudovicic@gmail.com if you have any questions.\r\n\r\n\r\nLicense\r\n-------\r\n\r\nCopyright (c) 2017- Christian Tai Udovicic. Released under the MIT license. This software comes with no warranties. See LICENSE.txt for details.\r\n\r\n\r\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/cjtu/craterpy", "keywords": "python crater data analysis planetary science", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "craterpy", "package_url": "https://pypi.org/project/craterpy/", "platform": "OS Independent", "project_url": "https://pypi.org/project/craterpy/", "project_urls": { "Homepage": "http://github.com/cjtu/craterpy" }, "release_url": "https://pypi.org/project/craterpy/0.2.1/", "requires_dist": [ "gdal", "matplotlib", "numpy", "pandas", "scipy" ], "requires_python": "", "summary": "A package for impact crater data science.", "version": "0.2.1" }, "last_serial": 3244391, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "ca9e78c8f1fbad9471e16c1be2f70ddc", "sha256": "5fdf07273f905bad44da9e51062dcaf5d1ff0ef123da571b72e77494286cd89c" }, "downloads": -1, "filename": "craterpy-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ca9e78c8f1fbad9471e16c1be2f70ddc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 878308, "upload_time": "2017-10-12T06:39:05", "url": "https://files.pythonhosted.org/packages/3d/7e/6779ba60e012bbaba87efde59855cf63f138b1fa0022e1d277822dcf012d/craterpy-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2594f28f7b95df1ecf60440a782073a5", "sha256": "68f5d9dc1f040bc5f839b3a1ccfbfbeafe92c35d6044a37480dc2e2fbc6d2b19" }, "downloads": -1, "filename": "craterpy-0.2.1.tar.gz", "has_sig": false, "md5_digest": "2594f28f7b95df1ecf60440a782073a5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18768, "upload_time": "2017-10-12T06:39:07", "url": "https://files.pythonhosted.org/packages/89/7f/a798f6d4d688edb7a6d64d5e22e628348b9bcb32811ec0f47aa18503954c/craterpy-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ca9e78c8f1fbad9471e16c1be2f70ddc", "sha256": "5fdf07273f905bad44da9e51062dcaf5d1ff0ef123da571b72e77494286cd89c" }, "downloads": -1, "filename": "craterpy-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ca9e78c8f1fbad9471e16c1be2f70ddc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 878308, "upload_time": "2017-10-12T06:39:05", "url": "https://files.pythonhosted.org/packages/3d/7e/6779ba60e012bbaba87efde59855cf63f138b1fa0022e1d277822dcf012d/craterpy-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2594f28f7b95df1ecf60440a782073a5", "sha256": "68f5d9dc1f040bc5f839b3a1ccfbfbeafe92c35d6044a37480dc2e2fbc6d2b19" }, "downloads": -1, "filename": "craterpy-0.2.1.tar.gz", "has_sig": false, "md5_digest": "2594f28f7b95df1ecf60440a782073a5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18768, "upload_time": "2017-10-12T06:39:07", "url": "https://files.pythonhosted.org/packages/89/7f/a798f6d4d688edb7a6d64d5e22e628348b9bcb32811ec0f47aa18503954c/craterpy-0.2.1.tar.gz" } ] }