Quick Install Guide#

Linux#

First we need to install a Conda distribution. There are a few options but we here we opt for MiniConda3 as it downloads quicker than the fuller Anaconda.

You can follow the install instructions for MiniConda3 or follow the commands below. Download.

mkdir -p ~/miniconda3
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh

Install MiniConda3

bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3

Activate the base environment in your current terminal

~/miniconda3/bin/conda init bash

It is recommended to create a new environment

conda create --name new_env python=3.11

Activate the new environment

conda activate new_env

Install GEOUNED from conda-forge

conda install -c conda-forge geouned -y

Then you will be able to run import GEOUNED from within Python

import geouned

You will also be able to use the GEOUNED command line tool

geouned_cadtocsg --help

Windows#

First we need to install a Conda distribution. There are a few options but we here we opt for MiniConda3 as it downloads quicker than the fuller Anaconda.

You can follow the install instructions for MiniConda3

Download and execute the Miniforge3 Windows installer

You can get it from the Miniforge3 GitHub repository here or from the link below

https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe

Open “Anaconda Prompt (miniconda3)” which will now be available on your start menu.

It is recommended to create a new environment

conda create --name new_env python=3.11

Activate the new environment

conda activate new_env

Since one of the GEOUNED dependencies is FreeCAD, classic conda solver of dependencies may significantly slow down the installation. For this reason, it is recommended to install and use conda-libmamba-solver

conda install conda-libmamba-solver

Install GEOUNED from conda-forge, forcing the use of libmamba solver

conda install -c conda-forge geouned -y --solver=libmamba

Then you will be able to run import GEOUNED from within Python

import geouned

You will also be able to use the GEOUNED command line tool

geouned_cadtocsg --help