Welcome to pyjc’s documentation!

Introduction

(Note: this project is currently in Alpha phase. Expect bugs.)

pyjc is a reference python package and module implementation for educational purposes. It is a project that enables one to:

  • learn how to develop, build, test, and release a bespoke Python package
  • reuse utilities
  • get hands-on experience building an open source software

“The structure of this repository is largely inspired by Stackoverflow and the NumPy GitHub repository.”

GitHub Repository

See this GitHub Repository

pyjc

pyjc package

Subpackages

pyjc.cal package
Submodules
pyjc.cal.add module
pyjc.cal.add.add(a, b)[source]

Add two numbers and return the result.

Parameters:a, b (numeric like)
Returns:out
Return type:numeric like

Examples

>>> add(2, 3)
5
>>> add(-2, 10)
8
>>> add(2., 3)
5.0
>>> add(-2., 10)
8.0

See also

pyjc.cal.divide(), pyjc.cal.subtract(), pyjc.cal.multiply()

pyjc.cal.divide module
pyjc.cal.divide.divide(a, b)[source]

Divide a from b, and return the result.

Parameters:a, b (numeric like)
Returns:out
Return type:numeric like 
>>> divide(3, 2)
1.5
>>> divide(10, -2)
-5.0
>>> divide(3., 2)
1.5
>>> divide(10., -2)
-5.0

See also

pyjc.cal.add(), pyjc.cal.subtract(), pyjc.cal.multiply()

pyjc.cal.multiply module
pyjc.cal.multiply.multiply(a, b)[source]

Multiply a and b, and return the result.

Parameters:a, b (numeric like)
Returns:out
Return type:numeric like 
>>> multiply(3, 2)
6
>>> multiply(10, -2)
-20
>>> multiply(3., 2)
6.0
>>> multiply(10, -2.)
-20.0

See also

pyjc.cal.add(), pyjc.cal.divide(), pyjc.cal.subtract()

pyjc.cal.subtract module
pyjc.cal.subtract.subtract(a, b)[source]

Subtract b from a, and return the result.

Parameters:a, b (numeric like)
Returns:out
Return type:numeric like 
>>> subtract(2, 3)
-1
>>> subtract(-2, 10)
-12

See also

pyjc.cal.add(), pyjc.cal.divide(), pyjc.cal.multiply()

Module contents
pyjc.cal

Contains toy calculation utilities, such as add, divide, multiply, and subtract.

To call the function pyjc.cal.add.add(), simply do a pyjc.cal.add() (i.e. skip the module name)

Module contents

pyjc
Provides
  1. A reference Python Package / Module Implementation for education purpose, inspired by Numpy.
  2. Utilities for Deep Learning Projects
How to use the documentation

Documentation is available in two forms: docstrings provided with the code, and a loose standing reference guide on ReadTheDoc.org (URL pending)

We recommend exploring the docstrings using Jupyter Console, an advanced Python shell with TAB-completion and introspection capabilities. See below for further instructions.

The docstring examples assume that pyjc has been imported as pyjc::
>>> import pyjc
Code snippets are indicated by three greater-than signs::
>>> x = 42
>>> x = x + 1
Use the built-in help function to view a function’s docstring::
>>> help(pyjc.cal.add)
... # Help on function add in module pyjc.cal.add:
... # add(a, b)
... #     Add two numbers and return the result.

To call the function pyjc.cal.add.add(), simply do a pyjc.cal.add() (i.e. skip the module name)

Indices and tables