Quickstart#

New releases of efficalc are distributed on PyPI.

Installation#

Install to your project via pip:

pip install efficalc

First Calculation Function#

Efficalc works best when calculations are defined as a function. The most common classes you’ll use are Input and Calculation.

For example, if you want a calculation for pythagorean’s theorem and the perimeter of a right triangle, your calculation may be:

from efficalc import Calculation, Input, Title, sqrt

def calculation():
    Title("Pythagorean's Theorem and Perimeter")

    a = Input("a", 3, description="Length of side a")
    b = Input("b", 4, description="Length of side b")

    c = Calculation("c", sqrt(a**2 + b**2), description="Length of the hypotenuse")

    Calculation("P", a + b + c, description="Perimeter of the triangle")

View Reports#

There are a few ways to produce a report for your calculations. To view and print the report from your browser, you can do something as simple as:

from efficalc.report_builder import ReportBuilder
from pythagorean_perimeter import calculation

builder = ReportBuilder(calculation)
builder.view_report()

Running this code gives us this nice report:

Change Input Values#

Now that’s great and easy, but it will always return the same calculation with the same default inputs that we gave in the Calculation function (3 and 4).

But we want to make our calculations flexible so we can use the same function for many different design inputs. Luckily, the ReportBuilder makes this super easy by supplying any input overrides to the second argument.

Here’s an example:

from efficalc.report_builder import ReportBuilder
from pythagorean_perimeter import calculation

# define the new inputs to override the defaults
new_inputs = {"a": 5, "b": 6}

# run the report with the input override values
builder = ReportBuilder(calculation, new_inputs)
builder.view_report()

Now, our report shows the updated inputs. Not the default inputs we defined in the calculation function:

And that’s all there is to it!