Installation

PoreScene is distributed via PyPI. The recommended way to install it is with uv – a fast, cross-platform (Windows, macOS and Linux) package and project manager that can also download and manage Python interpreters for you.

Note

The supported Python version is restricted by Blender’s bpy module, which is Python 3.13 at the moment. uv provides this interpreter on demand, so you do not need a system-wide Python installation.

Quick setup

If uv is already available on your system, create a project and add porescene to it:

uv init my-project --python 3.13
cd my-project
uv add porescene

If you do not have uv yet, follow the step-by-step setup below.

Step-by-step setup

1. Install uv

Install uv with the official standalone installer.

On Windows (PowerShell):

PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

On macOS and Linux:

$ curl -LsSf https://astral.sh/uv/install.sh | sh

Restart your terminal afterwards and verify the installation (all: Windows, macOS, Linux):

uv --version

Tip

uv is also available from common package managers, e.g. Homebrew (brew install uv) or WinGet (winget install astral-sh.uv). See the uv installation guide for all options.

2. Set up a project

Initialize a new project pinned to Python 3.13. uv downloads the interpreter if it is not present yet and manages a virtual environment and dependencies for you:

uv init my-project --python 3.13
cd my-project

3. Install PoreScene

Add porescene to the project:

uv add porescene

Now, you are ready to create impressive visualizations with PoreScene. See the next chapter for the basic concepts of PoreScene, or create your first rendering directly based on of the example scripts.