rockfinder
A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient detections are in fact known asteroids
Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.3%) to scientific vocabulary
Repository
A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient detections are in fact known asteroids
Basic Info
Statistics
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 4
- Releases: 1
Metadata Files
README.md
rockfinder
A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient dections are in fact known asteroids.
Command-Line Usage
Usage:
rockfinder where [-e] [csv|md|rst|json|yaml] <objectId> <mjd>...
csv output results in csv format
md output results as a markdown table
rst output results as a restructured text table
json output results in json format
yaml output results in yaml format
-e, --extra return extra ephemeris info (verbose)
-h, --help show this help message
Documentation
Documentation for rockfinder is hosted by Read the Docs (last stable version and latest version).
Installation
The easiest way to install rockfinder is to use pip:
pip install rockfinder
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/rockfinder.git
cd rockfinder
python setup.py install
To upgrade to the latest version of rockfinder use the command:
pip install rockfinder --upgrade
Development
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/rockfinder.git
cd rockfinder
python setup.py develop
Pull requests are welcomed!
Sublime Snippets
If you use Sublime Text as your code editor, and you're planning to develop your own python code with rockfinder, you might find my Sublime Snippets useful.
Issues
Please report any issues here.
License
Copyright (c) 2018 David Young
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
How to cite rockfinder
If you use rockfinder in your work, please cite using the following BibTeX entry:
bibtex
@software{Young_rockfinder,
author = {Young, David R.},
doi = {10.5281/zenodo.8038004},
license = {GPL-3.0-only},
title = {{rockfinder}},
url = {https://github.com/thespacedoctor/rockfinder}
}
Owner
- Name: David Young
- Login: thespacedoctor
- Kind: user
- Location: Belfast, UK
- Company: Queen's University Belfast
- Website: www.thespacedoctor.co.uk
- Repositories: 73
- Profile: https://github.com/thespacedoctor
Citation (CITATION.cff)
cff-version: 1.2.0 title: rockfinder message: If you use this software, please cite it as below. authors: - family-names: "Young" given-names: "David R." orcid: "https://orcid.org/0000-0002-1229-2499" doi: 10.5281/zenodo.7970743 url: "https://github.com/thespacedoctor/rockfinder" abstract: A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient dections are in fact known asteroids. keywords: [astronomy] license: GPL-3.0-only
GitHub Events
Total
Last Year
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| thespacedoctor | n****e@g****m | 53 |
| Dave | d****g@q****k | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 5
- Total pull requests: 2
- Average time to close issues: 4 months
- Average time to close pull requests: N/A
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 3.6
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mtbannister (2)
- thespacedoctor (2)
- asteroidnerd (1)
Pull Request Authors
- dependabot[bot] (2)
- mtbannister (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 88 last-month
- Total dependent packages: 0
- Total dependent repositories: 3
- Total versions: 16
- Total maintainers: 1
pypi.org: rockfinder
A python package and command-line tools to A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient dections are in fact known asteroids
- Homepage: https://github.com/thespacedoctor/rockfinder
- Documentation: https://rockfinder.readthedocs.io/
- License: MIT
-
Latest release: 0.6.1
published about 7 years ago
Rankings
Maintainers (1)
Dependencies
- fundamentals *
- grequests *
- ndg-httpsclient *
- psutil *
- pyyaml *
- rockfinder *
- Markdown ==3.3.4
- MarkdownSubscript *
- docopt *
- importlib-metadata ==4.13.0
- jinja2 ==3.0.0
- lxml *
- m2r *
- mdx_include >1.3
- mistune <2.0.0
- mock >4.0
- psutil >5.7
- pymdown-extensions >8.0
- sphinx ==3.5.4
- sphinx_markdown_parser master
- sphinxcontrib-mermaid *
- unicodecsv *