How to Install ShapeWorks?

First, download ShapeWorks

Release Builds

We provide the following official user releases.
Windows
Mac
Linux

Their features can be seen at Release Notes.

Development Builds

We also provide up-to-date development builds from the master branch
Windows Dev Build
Mac Dev Build
Linux Dev Build

Please understand that these are in-progress development builds, not official releases.

Next, follow the instructions for your platform.

Windows
Mac
Linux

Installing ShapeWorks on Windows

Please make sure that you download the latest ShapeWorks binary release, or up-to-date development builds from the master branch for Windows (remember these are in-progress development builds, not official releases).

Installation instructions.

  1. Download and install the "Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019."
    https://aka.ms/vs/16/release/vc_redist.x64.exe

  2. Download and install Miniconda for Windows.
    https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe

  3. Double-click on the installer that you downloaded and follow the instructions.
    Please choose whatever installation directory you want.

  4. Open an Anaconda terminal and change directory to the chosen installation path.
    cd "C:\Program Files\ShapeWorks"

  5. Create the shapeworks conda environment, installing everything necessary to run.
    install_shapeworks
    Note: You can pass a different name for the environment, enabling multiple installations.
    install_shapeworks shapeworks_61

Warning

If you already have anaconda/miniconda installed, this step may hang. If so please uninstall anaconda/miniconda, re-install it, then run install_shapeworks again. This seems to be an occasional problem with Anaconda on Windows.

ShapeWorks comes with Python examples to get you started.

  1. Open an Anaconda terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Copy the Examples folder to another location of your choosing (you can also use Explorer).
    xcopy /E/H Examples %HOMEPATH%\ShapeWorks-Examples\

  3. Change to the Python folder of the Examples directory you copied.
    cd %HOMEPATH%\ShapeWorks-Examples\Python

  4. Run one of the included use cases. To list them all, run: python RunUseCase.py --help.
    python RunUseCase.py <insert name of use case here>

  5. More information about running use cases can be found here.

ShapeWorks also includes interactive Jupyter Python notebook examples.

  1. Open an Anaconda terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Change to the notebook tutorials folder of the Examples directory you copied.
    cd %HOMEPATH%\ShapeWorks-Examples\Python\notebooks\tutorials

  3. Start the Jupyter notebook server. This will open a new tab in your web brower.
    jupyter notebook

  4. Click on a notebook to get started.

Important

Your shapeworks conda environment must always be activated before using ShapeWorks.

Using git-bash on Windows

Windows may also have a git-bash command line available. This also works with conda, and environments are activated in the same way. However, there is one important issue: running Python scripts requires prefixing with winpty. For example, winpty ....

Installing ShapeWorks on Mac

Please make sure that you download the latest ShapeWorks binary release, or up-to-date development builds from the master branch for Mac (remember these are in-progress development builds, not official releases).

Installation instructions.

  1. Install the ShapeWorks .pkg file by double-clicking on the file.

  2. Open a terminal and change directory to the installation path.
    cd /Applications/ShapeWorks

  3. Create a protected conda environment that installs everything necessary to run.
    source install_shapeworks.sh
    Note: You can pass a different name for the environment, enabling multiple installations.
    source install_shapeworks.sh shapeworks_61

ShapeWorks comes with Python examples to get you started.

  1. Open a terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Copy the Examples folder to another location of your choosing.
    cp -r Examples $HOME/ShapeWorks-Examples

  3. Change to the Python folder of the Examples directory you copied.
    cd $HOME/ShapeWorks-Examples/Python

  4. Run one of the included use cases. To list them all, run: python RunUseCase.py --help.
    python RunUseCase.py <insert name of use case here>

  5. More information about running use cases can be found here.

ShapeWorks also includes interactive Jupyter Python notebook examples.

  1. Open a terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Change to the notebook tutorials folder of the Examples directory you copied.
    cd $HOME/ShapeWorks-Examples/Python/notebooks/tutorials

  3. Start the Jupyter notebook server. This will open a new tab in your web brower.
    jupyter notebook

  4. Click on a notebook to get started.

Important

Your shapeworks conda environment must always be activated before using ShapeWorks.

Installing ShapeWorks on Linux

Please make sure that you download the latest ShapeWorks binary release, or up-to-date development builds from the master branch for Linux (remember these are in-progress development builds, not official releases).

Installation instructions.

  1. Open a terminal and change directory to the installation path (where you unzipped the downloaded file).
    cd /path/to/shapeworks

  2. Create a protected conda environment that installs everything necessary to run.
    source install_shapeworks.sh
    Note: You can pass a different name for the environment, enabling multiple installations.
    source install_shapeworks.sh shapeworks_61

ShapeWorks comes with Python examples to get you started.

  1. Open a terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Copy the Examples folder to another location of your choosing.
    cp -r Examples $HOME/ShapeWorks-Examples

  3. Change to the Python folder of the Examples directory you copied.
    cd $HOME/ShapeWorks-Examples/Python

  4. Run one of the included use cases. To list them all, run: python RunUseCase.py --help.
    python RunUseCase.py <insert name of use case here>

  5. More information about running use cases can be found here.

ShapeWorks also includes interactive Jupyter Python notebook examples.

  1. Open a terminal and activate the shapeworks conda environment (use the environment name passed to install_shapeworks above).
    conda activate shapeworks

  2. Change to the notebook tutorials folder of the Examples directory you copied.
    cd $HOME/ShapeWorks-Examples/Python/notebooks/tutorials

  3. Start the Jupyter notebook server. This will open a new tab in your web brower.
    jupyter notebook

  4. Click on a notebook to get started.

Important

Your shapeworks conda environment must always be activated before using ShapeWorks.