Clean looking engineering calculations for IPython
Project description
ipycalc
Simple Engineering Calculations in Python
Turn the contents of a Jupyter cell into a formatted calculation by following the steps below:
- Install
ipycalc
usingpip install ipycalc
- Use
import ipycalc
to bringipycalc
into your notebook's namespace. - Use
%%calc
as the first line of a cell to indicate that you want to runipycalc
on the contents of a cell.
The basic calculation syntax is:
Variable Description: variable_name
= python_expression
-> result_decimal_places
*result_unit
# Reference Text
Key components of the ipycalc
syntax are:
:
(required) The description must come before this character.=
(optional) Used to assign a python expression to a variable name. Omit this if you simply want to reprint a previously defined variable.->
(optional) Separates the python expression from the results formatting rules.*
(optional) Indicate the number of decimals you want to see in the result to the left of the*
, and the units you want to see in the result to the right.#
(optional) Indicates reference text to the side of the calculation - handy for equation references or code references.
Here are a few useful things to keep in mind when using ipycalc
:
- Subscripts can be added by using the
_
character to indicate the start of a subscript. - To stack fractions place the numerator and denominater in parentheses: (num)/(denom) yields $\dfrac{num}{denom}$.
If
statements andelse
statements are available using python's inlineif
statement notation.- Square roots can be displayed using
sqrt
. - Prime characters can be displayed using
^prime
. - If a line gets too long for printing, you can add a line break to the description, equation, or reference by inserting
\\
. ipycalc
has a built innbconvert
template calledipycalc
that works just like thewebpdf
template, except it fixes the the bad margins in thewebpdf
template, reduces the print size to 85% to fit more calcs on a single sheet, and avoids page breaks right after headers.
IPycalc is still in its infancy. I'm sure there are bugs, so be cautious and use your head. A special thanks to @connorferster for handcalcs
which inspired this project: https://github.com/connorferster/handcalcs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.