Skip to content

Installation

Requirements

Blueprints requires Python 3.12 or higher.

Before installing, ensure you have a compatible Python version:

python --version

Basic Installation

Package Name

The package is installed as blue-prints (with a dash), but you import it as blueprints (without a dash) in your Python code.

Installing the Latest Release

To install the latest stable release from PyPI:

pip install blue-prints

uv add blue-prints

Installing a Specific Version

To install a specific version of Blueprints:

pip install blue-prints==0.5.2

uv add blue-prints==0.5.2

Tip

You can find all available versions on the PyPI releases page or GitHub releases.

Installing the Development Version

To install the actively developed version directly from GitHub:

pip install git+https://github.com/Blueprints-org/blueprints.git

uv add git+https://github.com/Blueprints-org/blueprints.git

Verifying Installation

After installation, verify that Blueprints is correctly installed:

import blueprints
print(blueprints.__version__)

Core Dependencies

Blueprints automatically installs the following required dependencies:

  • matplotlib - For plotting and visualization
  • numpy - For numerical computations
  • sectionproperties - For cross-section analysis
  • shapely - For geometric operations

These dependencies are installed automatically and are required for the core functionality of Blueprints.

Troubleshooting

Python Version Issues

If you encounter errors related to Python version, ensure you're using Python 3.12 or higher:

python --version

Next Steps

Now that you have Blueprints installed, you can:

Getting Help

If you encounter any installation issues: