Skip to content

Installation

Without installing: run directly with uv

If you just want to run a script that uses eagar-tsai without adding it to a project or creating a virtual environment, uv can handle that in one step:

uv run --with eagar-tsai python my_script.py

uv fetches the package into a temporary, isolated environment and runs your script inside it. Nothing is installed globally or into any project. This is the fastest way to try the package or run a one-off calculation on a machine where you do not want to manage a project environment.

Add to a project

uv add eagar-tsai

pip install eagar-tsai

Pre-built binary wheels are published to PyPI for Python 3.12, 3.13, and 3.14 on Linux (x86-64, glibc and musl), macOS (Intel and Apple Silicon), and Windows (x86-64 and 32-bit x86). If a matching wheel exists for your platform, no C compiler is needed; pip or uv will download and install the pre-compiled package directly.

Building from source

If no pre-built wheel matches your platform (for example, a non-standard Linux architecture or a Python version newer than 3.14), the package falls back to building from the source distribution. In that case a C compiler is required:

  • Linux/macOS: GCC or Clang (usually pre-installed)
  • Windows: MSVC Build Tools or MinGW-w64

Optional: Plotting Dependencies

matplotlib and pyvista are not installed by default, since core computation does not need them. Install the plot extra to use plot_temperature_field, plot_temperature_field_3d, plot_printability_map, or the .plot() / .plot_3d() / export_vti() methods on MeltPoolResult, TemperatureField, and TemperatureVolume:

uv add "eagar-tsai[plot]"

pip install "eagar-tsai[plot]"

Calling a plotting function without the extra installed raises an ImportError naming the missing packages.