Contributors guide#

The guidelines for contributing to this pacakge.

The logical order of the modules in gbox package

(LOW LEVEL) utils.py >> elements.py >> shapes.py >> gbox.py (TOP LEVEL)

WIP/Goals#

  1. At present Only Circle and Ellipse contain the specified number of points on the locus. As, other shapes are made up of multiple elements, needs to find the right number of points on each element of the shape.

  2. Convert Points(list) to Points(numpy.ndarray) and see if there is any performance gain

  3. Updating the documentation

    • Add schematics of the shapes

    • Add formulae for all implementations of area, perimeter…etc.

  4. UnS representation of closed shapes

  5. Adding 3D shapes