{"id":35223648,"url":"https://github.com/cjtu/craterpy","last_synced_at":"2026-04-10T10:02:30.255Z","repository":{"id":19994020,"uuid":"88457986","full_name":"cjtu/craterpy","owner":"cjtu","description":"A python library for impact crater data science","archived":false,"fork":false,"pushed_at":"2025-09-30T15:28:11.000Z","size":38319,"stargazers_count":22,"open_issues_count":11,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-01-02T06:14:32.879Z","etag":null,"topics":["data-science","open-science","planetary","python"],"latest_commit_sha":null,"homepage":"https://craterpy.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cjtu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-04-17T02:10:37.000Z","updated_at":"2025-11-12T17:56:38.000Z","dependencies_parsed_at":"2023-12-15T21:17:36.162Z","dependency_job_id":"39aaedc8-2a7e-4dab-89b5-dc479ae34aa5","html_url":"https://github.com/cjtu/craterpy","commit_stats":{"total_commits":266,"total_committers":8,"mean_commits":33.25,"dds":"0.19548872180451127","last_synced_commit":"ef2fa751fa34ba7b54389a789bf181b40b4d66f3"},"previous_names":["cjtu/acerim"],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/cjtu/craterpy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjtu%2Fcraterpy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjtu%2Fcraterpy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjtu%2Fcraterpy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjtu%2Fcraterpy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cjtu","download_url":"https://codeload.github.com/cjtu/craterpy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjtu%2Fcraterpy/sbom","scorecard":{"id":284487,"data":{"date":"2025-08-11","repo":{"name":"github.com/cjtu/craterpy","commit":"20f48f980b5dadf7d18bd9a1d309f0fd76e5f3bb"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":2,"reason":"Found 5/21 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"11 commit(s) and 9 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/code_quality_checks.yml:1","Warn: no topLevel permission defined: .github/workflows/draft-joss.yml:1","Warn: no topLevel permission defined: .github/workflows/pypi_publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code_quality_checks.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/code_quality_checks.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/code_quality_checks.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/code_quality_checks.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-joss.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/draft-joss.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/draft-joss.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/draft-joss.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-joss.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/draft-joss.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi_publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/pypi_publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi_publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/pypi_publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/cjtu/craterpy/test.yml/main?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T16:53:48.494Z","repository_id":19994020,"created_at":"2025-08-17T16:53:48.494Z","updated_at":"2025-08-17T16:53:48.494Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31637748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-science","open-science","planetary","python"],"created_at":"2025-12-30T00:57:55.206Z","updated_at":"2026-04-10T10:02:30.248Z","avatar_url":"https://github.com/cjtu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cstrong\u003eCraterpy:\u003c/strong\u003e\u003cem\u003e Impact crater data science in Python\u003c/em\u003e\n\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- PYPI version --\u003e\n  \u003ca href=\"https://pypi.org/project/craterpy\"\u003e\n    \u003cimg alt=\"PyPI badge\" src=\"https://img.shields.io/pypi/v/craterpy\"\u003e\n  \u003c/a\u003e\n  \u003c!-- Tests (GitHub Actions CI) --\u003e\n  \u003ca href=\"https://github.com/cjtu/craterpy/actions/workflows/test.yml\"\u003e\n    \u003cimg src=\"https://github.com/cjtu/craterpy/actions/workflows/test.yml/badge.svg\"\n      alt=\"Tests badge\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- Test Coverage (codecov) --\u003e\n  \u003ca href=\"https://codecov.io/gh/cjtu/craterpy\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/cjtu/craterpy/branch/main/graph/badge.svg?token=9K567x0YUJ\"\n      alt=\"Codecov badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/astral-sh/ruff\"\u003e\n    \u003cimg src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\"\n      alt=\"Ruff badge\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- ReadTheDocs --\u003e\n  \u003ca href=\"http://craterpy.readthedocs.io/latest/?badge=latest\"\u003e\n    \u003cimg src=\"http://readthedocs.org/projects/craterpy/badge/?version=latest\"\n      alt=\"Docs badge\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- Code of Conduct --\u003e\n  \u003ca href=\"CODE_OF_CONDUCT.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\"\n      alt=\"Contributor Covenant\" /\u003e\n      \u003c/a\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- JOSS badge --\u003e\n  \u003ca style=\"border-width:0\" href=\"https://doi.org/10.21105/joss.08663\"\u003e\n    \u003cimg src=\"https://joss.theoj.org/papers/10.21105/joss.08663/status.svg\" alt=\"DOI badge\" \u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n# Overview\n\nCraterpy makes it easier to work with impact crater data in Python. Highlights:\n\n- convert a table of crater coordinates and sizes to a GeoDataFrame or GIS-ready shapefile\n- extract zonal statistics associated with each crater in circlular or annular regions (with [rasterstats](https://pythonhosted.org/rasterstats/))\n- eliminate some pain points of planetary GIS analysis (antimeridian wrapping, projection conversions, etc.)\n- supports all roughly spherical cratered bodies ([examples](https://craterpy.readthedocs.io/latest/planetary_body_examples.html))\n\nNote: Craterpy is not a crater detection algorithm (e.g. [PyCDA](https://github.com/AlliedToasters/PyCDA)), nor is it a crater count age dating tool (see [craterstats](https://github.com/ggmichael/craterstats)).\n\n**Note:** *Craterpy is in development. We appreciate bug reports and feature requests on the [issues board](https://github.com/cjtu/craterpy/issues).*\n\n\n## Quickstart\n\nInstall with `pip install craterpy` then see example usage at [Getting Started](https://craterpy.readthedocs.io/latest/getting_started.html).\n\n## Demo\n\nQuickly import tabluar crater data from a CSV and visualize it on a geotiff in 2 lines of code:\n\n```python\nfrom craterpy import CraterDatabase, sample_data as sd\n\ncdb = CraterDatabase(sd['vesta_craters_km.csv'], 'Vesta', units='km')\ncdb.plot(sd['vesta.tif'], alpha=0.5, color='tab:green', savefig='readme_vesta_cdb.png')\n```\n\n![Vesta map plot](https://github.com/cjtu/craterpy/raw/main/docs/_images/readme_vesta_cdb.png)\n\nClip and plot targeted regions around each crater from large raster datasets.\n\n```python\ncdb.add_circles('crater_roi', 1.5)\ncdb.plot_rois(sd['vesta.tif'], 'crater_roi', range(3, 12))\n```\n\n![Vesta plot rois](https://github.com/cjtu/craterpy/raw/main/docs/_images/readme_vesta_rois.png)\n\nExtract zonal statistics for crater regions of interest.\n\n```python\nimport pandas as pd\nfrom craterpy import CraterDatabase, sample_data as sd\ndf = df = pd.read_csv(sd[\"moon_craters_km.csv\"])\ncdb = CraterDatabase(df[df[\"Diameter (km)\"] \u003c 60], \"Moon\", units=\"km\")\n\n# Define regions for crater floor, rim (sizes in crater radii)\ncdb.add_annuli(\"floor\", 0.4, 0.6)  # crater floor, excluding possible central peak\ncdb.add_annuli(\"rim\", 0.99, 1.01)  # thin annulus at rim\n\n# Pull statistics from a Lunar Digital Elevation Model (DEM) GeoTiff\nstats = cdb.get_stats(sd[\"moon_dem.tif\"], regions=['floor', 'rim'], stats=['mean'])\n\n# Use mean elevations to compute depth (rim to floor)\nstats['crater_depth (m)'] = (stats.mean_rim - stats.mean_floor)\nprint(stats.head().to_string(float_format='%.1f', index=False))\n\n#  Diameter (km)  Latitude  Longitude  mean_floor  mean_rim  crater_depth (m)\n#           60.0      19.4     -146.5      6070.0   10792.9            4722.9\n#           60.0      44.2      145.3      -976.4    3114.0            4090.4\n#           60.0     -43.6       -7.5     -3617.5     186.8            3804.4\n#           60.0      -9.6      134.7      1843.4    6127.9            4284.4\n#           59.9     -25.3        2.4     -2634.2    -945.0            1689.1\n```\n\n## Cite This Repository\n\nIf you use this project in your research, please cite the [JOSS paper](https://doi.org/10.21105/joss.08663) as below:\n\n\u003e Tai Udovicic et al., (2025). Craterpy: Impact crater data science in Python. Journal of Open Source Software, 10(113), 8663, https://doi.org/10.21105/joss.08663\n\n```bibtex\n@article{craterpy2025, \ndoi = {10.21105/joss.08663},\nauthor = {Tai Udovicic, Christian J. and Essunfeld, Ari and Costello, Emily S.},\ntitle = {Craterpy: Impact crater data science in Python},\njournal = {Journal of Open Source Software},\nurl = {https://doi.org/10.21105/joss.08663},\nyear = {2025},\npublisher = {The Open Journal},\nvolume = {10},\nnumber = {113},\npages = {8663}}\n```\n\n## Documentation\n\nFull API documentation and usage examples are available at [ReadTheDocs](https://craterpy.readthedocs.io/).\n\n\n## Installation\n\nWe recommend pip installing craterpy into a virtual environment, e.g. with `conda` or `venv`:\n\n```bash\npip install craterpy\n```\n- **Note**: Craterpy is tested on latest long-term support versions of Windows, OS X and Ubuntu, and Python version 3.10 and up.\n\n## Contributing\n\nThere are two major ways you can help improve craterpy:\n\n- Report bugs or request new features on the [issues](https://github.com/cjtu/craterpy/issues) board.\n\n- Contributing directly. See [CONTRIBUTING.rst](https://github.com/cjtu/craterpy/blob/main/CONTRIBUTING.rst) for full details. First time open source contributors are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjtu%2Fcraterpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcjtu%2Fcraterpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjtu%2Fcraterpy/lists"}