PyTWD

Welcome to PyTWD's documentation page.

PyTWD is a Python package that was developed to support engineers in their calculation work using Python and the Jupyter environment.

The core functionality of PyTWD is summarized in the following picture:

As shown above, PyTWD combines three key capabilities:

Performing calculations using symbolic notation,
Using quantified values in these calculations,
Reporting the calculations in PDFs that look great.

The following snippet showcases these three capabilities:

Which will result in the following PDF document:

Calculations like these are at the heart of any engineering analysis. On top of the core functionalities, multiple subpackages have been developed to automate the boring and repetitive work, such as:

formatter() module provides a Jupyter notebook formatter to speed up the creation of hand calculations
library() subpackage provides the Engineering Design Assistant (EDA) that contains a library of standard engineering values (bolt properties, steel profile properties, formulas, etc.)
workflow() subpackage supports passing values between (Jupyter notebook) calculations using the database.
table_calculations() subpackage provides methods to perform repeated calculations
automated_notebooks() and pytwd.templates() subpackages support the automatic generation of widgetized notebook templates

PyTWD has been optimized for use in the Jupyter environment, but can also be used in stand-alone scripts.

Table of contents: