geomi.planar package

Submodules

geomi.planar.mod1 module

# This syntax with :: and a blank line allows highlighting a code block
foo = 34
bar = 22

foo = 34
bar = 22
_images/geom-shapes.jpg

Figure 2: Geometric shapes

This is a module containing functions on planar geometry.

Description:

Functions in this module enable simple calculations: + Find the distance between two points + Find the intersecting points of two lines/curves + Find the axis intercepts of lines/curves + Find the local min/max of curves + Find the area between two lines/curves + Find the area within closed shapes (triangles, polygons) + Find the angle between two intersecting lines

For some functions there is support for both Cartesian as well as Polar coordinate systems. Please consult the documentation at function level.
Dependencies:
  • numpy: basic requirement for all math computations
Todo:
  • Find the perpendicular distance from a point to a line
  • Transformations such as rotating a line by x radians
  • Asymptotes of a hyperbola
class geomi.planar.mod1.Planar1

Docstring for class Foo.

bar = 1

Doc comment for class attribute Foo.bar. It can have multiple lines.

baz = 2

Docstring for class attribute Foo.baz comes after the attribute.

flox = 1.5

Doc comment for Foo.flox. One line only.

func_in()

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Cras viverra mollis pharetra. Nam semper, lectus sit amet tincidunt maximus, nibh tellus accumsan neque, ac varius lacus ante nec augue. Maecenas volutpat sed ipsum ut lacinia. Ut sed consectetur libero. Mauris velit est, scelerisque quis libero eget, aliquet blandit est. Donec bibendum odio et velit convallis, et scelerisque ante fermentum. Duis congue sem ex, at semper turpis egestas nec. Aenean eu condimentum orci, ac efficitur nulla. Etiam facilisis varius quam, at ultrices lectus semper eget. Suspendisse ultrices eros eu porttitor ornare. Nunc vitae diam ultricies, interdum mi a, faucibus leo.

qux = None

Comment on a single line for an instance attribute.

spam = None

Docstring for instance attribute spam comes after the attribute. This could be very descriptive and spanning multiple lines.

geomi.planar.mod1.func1(name, state=None)

This function does something.

Parameters:
  • name (str) – The name to use.
  • state (bool) – Current state to be in.
Returns:

int: error code that is non-zero if in error.
Raises:

AttributeError, KeyError

geomi.planar.mod2 module

geomi.planar.mod2.func1()

This is func1 dummy docstring.

External Ref:

Module contents

This is the planar module that encapsulates a couple of submodules.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras viverra mollis pharetra. Nam semper, lectus sit amet tincidunt maximus, nibh tellus accumsan neque, ac varius lacus ante nec augue. Maecenas volutpat sed ipsum ut lacinia. Ut sed consectetur libero. Mauris velit est, scelerisque quis libero eget, aliquet blandit est. Donec bibendum odio et velit convallis, et scelerisque ante fermentum. Duis congue sem ex, at semper turpis egestas nec. Aenean eu condimentum orci, ac efficitur nulla. Etiam facilisis varius quam, at ultrices lectus semper eget. Suspendisse ultrices eros eu porttitor ornare. Nunc vitae diam ultricies, interdum mi a, faucibus leo.