Skip to content

dippykit/dippykit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dippykit - A Digital Image Processing Library

Authors: Brighton Ancelin, Motaz Alfarraj, Ghassan AlRegib.

This library was developed for the Georgia Tech's graduate course ECE 6258: Digital Image Processing with Professor Ghassan AlRegib.

Documentation can be found here.

Installation Instructions

The llibrary can be installed via

pip install git+https://github.com/olivesgatech/dippykit.git

To verify your installation, follow the instructions given here.

Purpose

This package is intended for use by Digital Image Processing students. It serves as an educational resource. The general methodology for the package is that each module contains functions pertinent to a specific concept or field. For convenience to the user, all functions are available directly through the package itself. In other words, users are not tasked with specifying modules to access specific members. The organization of modules is a logical "under-the-hood" aspect in this regard.

Known Issues

On some Mac devices this library has issues when running on Python 3.6.9 and up. Notably, Python may crash whenever one attempts to invoke the backend to matplotlib through functions such as dippykit.show. We are working to resolve these issues, but for the moment we recommend any Mac users to use Python 3.6.8 with this library.

When installing on Windows WSL environment, some may notice import errors pertaining to skbuild. To resolve this, one may need to manually specify to install skbuild with the following command: pip install scikit-build.

Versioning Scheme

This code is maintained under the Semantic Versioning 2.0.0 versioning scheme, further defined here In essence, the version is represented as MAJOR.MINOR.PATCH and each increments by the following rules:

  • Increment MAJOR when incompatible API changes are made
  • Increment MINOR when backwards-compatible functionality is added
  • Increment PATCH when backwards-compatible bug fixes are made

About

A Python Package for Educational Image Processing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages