cjtu/craterpy

A python library for impact crater data science

craterpy's Issues

Investigate releasing on conda-forge

As noted in (#8), quick installation is bulky right now due to gdal dependency issues that arise with pip that are mitigated by conda.

1. What would it take to get craterpy hosted on conda-forge?
2. Would this simplify installation instructions (e.g., would dependencies be correctly built with conda install -c conda-forge craterpy)?

Fix README

• Code snippet (syntax error at index, need to be run inside data folder)
• Tutorial link
• Clean up quick installation section, should not need to install dependencies manually as pip install should handle that
• Create section for building from source (for contributors), using environment.yml to install dependencies, running tests
• Rename "Citing ACERIM" to "Citing craterpy"

Custom Exceptions

Replace current exceptions like "ValueError" or "ImportError" with custom exceptions defined in a file called exceptions.py. They should have useful names and inherit from the Exception they replace

Improve Docstrings

Docstrings

Docstings are important for auto-building API docs for craterpy. We use the numpy style guide which has a great summary here

TODO:

• Give all modules, classes, functions, and methods a docstring (min 1 line description).
• "Attributes" and "methods" sections for all classes
• "Parameters" section for all functions, methods (where applicable)
• "Returns" section for all functions, methods (where applicable)
• "Raises" section if Exceptions are raised
• "Examples" section and update existing examples

Fix .environment.yml on OSX

Installing from provided .environment.yml on OSX throws error; attached version works (rename to .environment.yml using mv environment.txt .environment.yml)
environment.txt

Get Test Coverage Up

Test coverage is currently very low. Let's get it up to 90% or more and keep it there

greatcircdist breaking for abs(longitude) > 90

ValueError: Latitude or longitude out of bounds.

generated when the absolute value of the first longitude in the input pair is >90 deg.
Example: greatcircdist(10., -95., 50.,75, 1737)

Work on OSS Project Checklist

OSS Project Checklist

A checklist from https://github.com/scriptnull/oss-checklist to be a guide future open-source development of craterpy.

Pre-checks

• Able to explain your project in a tweet ?
• Choose a name for the project
• Check if domain name / App name is available ?
• List and learn tools required for the project
• Prepare mock-up and one page design document, if needed to explain to collaborators
• List previous / similar implementations and learn from them
• Start a blog post to document the journey ( if time permits ) Mention idea + helpful resources.
• Ask if project could be solved in a modular way by dividing into sub-problems and creating a separate project for the sub-problems.

Project Creation

• Create a Repository in Github
• Create a README.rst (check below for more)
• Create a LICENSE file (choose one before)
• Create a CONTRIBUTING.rst
• Create a .gitignore

README.md Checklist

• Title
• Logo
• Badges
• Description
• Prerequisite for using software ( if any )
• Install
• Example Usage
• Screenshots and GIFs
• Contributors
• Attributions ( mention 3rd party libs used etc. )

Coding Phase

• Install required developer tools
  • Compiler
  • Linter
  • Build Tools
  • Other
• Organize files and folders that will help readers to find code easily
• Basic code complete
• Write tests and keep watch on code coverage
• Setup CI
  • Setup CI on Linux (Travis CI)
  • Setup CI on Windows (AppVeyor)
  • Setup CI on OS X (tricky with anaconda, explore further)
• Host the documentation of the code on ReadTheDocs
• Use Github issues ( or other tools ) for tracking backlogs
• Encourage OSS culture by having labels like "help wanted" "easy-to-contribute" etc.
• Contribute to other OSS projects on which the current project is dependent on ( if possible )
  • File bug reports
  • Improve docs
  • Suggest feature
  • Learn by reading code

Release Phase

• Package software in CI or manually in local
• Publish in registries (PyPI, conda-forge, etc.)
• Create the release version, description, link for downloading the release etc. in release page ( example: Github release page)

Post-release

• Publish the blog post
• Tweet
• Hackernews
• Product Hunt
• Send PR to awesome-* github repository
• Reddit
• Hashnode
• Linkedin
• Edit Wikipedia pages (if related)
• Prepare slides and give talks (if possible)

Add Continuous Integration for OS X

Currently only testing on Windows (Appveyor) and Linux (Travis). Add OS X

Teach SSXG lab how to contribute to craterpy

Demo for spooky Haloween lab meeting