Installation

Note

Whenever you are updating seg2mesh, remember to first do a git pull (or Download the ZIP and extract) to get the latest version.

Prerequisites

uv is an ultra-fast Python package manager that makes environment and dependency management much easier.

To install on Windows, in a Powershell terminal execute:

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

To install on macOS or Linux execute:

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

On Windows:

You have options, but if you’re new to Git, a simple solution is to install the GitHub Desktop application.

On macOS:

Again, you have options, but using brew is quite nice.

If you need to install brew, you can do so with,

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

You can then install git with,

brew install git

On Linux:

Using your distribution’s package manager is the most straightforward option.

For example, on Debian/Ubuntu flavors, you can use apt with,

sudo apt install git

On Arch-based flavors, you can use pacman with,

sudo pacman -S git

If you have an ssh key set up for GitHub, clone the repository using ssh:

git clone git@github.com:seg2mesh/seg2mesh.git

If you don’t have an ssh key set up, clone the repository using https:

git clone https://github.com/seg2mesh/seg2mesh.git

You can download the repository as a ZIP file, by clicking on the green rectangle with the “< >” and selecting “Download ZIP”.

After completing the prerequisites, you can install seg2mesh by running the following command:

uv sync

From anywhere in the repository root directory or below.

If you cloned the repository using Git, you can update to the latest version with:

git pull

and then run,

uv sync

Congratulations! You have successfully installed seg2mesh.