Skip to content

How to Install ShapeWorks?

First, download ShapeWorks

Release Builds

We provide official user releases for Windows, MacOS, and 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).

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

  2. Double-click on the ShapeWorks installer that you downloaded and follow the installation steps.

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

  4. Create the shapeworks conda environment, installing everything necessary to run.
    install_shapeworks.bat

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.

Important

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

ShapeWorks comes with examples to get you started.

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

Studio

  1. Open ShapeWorks Studio

  2. Select "Open Exising Project"

  3. Select Examples/Studio/Ellipsoid/ellipsoid.xlsx

  4. Experiment with the Studio interface.

Python

  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 Python folder of the Examples directory you copied.
    cd %HOMEPATH%\ShapeWorks-Examples\Python

  3. Run one of the included use cases. To list them all, run: python RunUseCase.py --help.
    python RunUseCase.py ellipsoid

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 browser.
    jupyter notebook

  4. Click on a notebook to get started.

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).

  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

Important

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

ShapeWorks comes with examples to get you started.

Studio

  1. Copy the /Applications/ShapeWorks/Examples folder to another location of your choosing. (You can also use Finder.)

  2. Open ShapeWorks Studio

  3. Select "Open Exising Project"

  4. Select Examples/Studio/Ellipsoid/ellipsoid.xlsx

  5. Experiment with the Studio interface.

Python

  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 broswer.
    jupyter notebook

  4. Click on a notebook to get started.

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).

  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

Important

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

ShapeWorks comes with examples to get you started.

Studio

  1. Open ShapeWorks Studio

  2. Select "Open Exising Project"

  3. Select Examples/Studio/Ellipsoid/ellipsoid.xlsx

  4. Experiment with the Studio interface.

Python

  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 broswer.
    jupyter notebook

  4. Click on a notebook to get started.