ShapeWorks Cloud

This is a cloud based webapp alternative to a desktop application called ShapeWorks Studio, made in collaboration with ShapeWorks. See the ShapeWorks Website for more details.

Deployed Instance

See https://www.shapeworks-cloud.org/.

Or, access the OpenAPI REST interface at https://app.shapeworks-cloud.org/api/docs/swagger/.

For admins, visit https://app.shapeworks-cloud.org/admin.

Quick Start

Using docker compose is the simplest configuration to start with, so it is a prerequisite for this quick start. These installation instructions assume you have a a modern linux based system with a docker version 20.10.13 or greater. It may work on other systems as well.

Initial Setup

1. Run git clone git@github.com:girder/shapeworks-cloud.git
2. Run cd shapeworks-cloud
3. Run docker compose build
4. Run docker compose run --rm django ./manage.py migrate
5. Run docker compose run --rm django ./manage.py createsuperuser
6. Run docker compose run --rm django ./manage.py makeclient

Run Application

1. Run docker compose up
2. Access the site, starting at http://localhost:8081/
3. Access admin console at http://localhost:8000/admin/
4. When finished, use Ctrl+C

Example Data

The ShapeWorks Cloud Client (SWCC) is a Python library to interact with a ShapeWorks Cloud server. You can use SWCC to upload some example data.

1. Run pip install swcc

   For developers, use pip install -e ./swcc

2. Run cd swcc/examples

3. Run python upload_examples.py

Application Maintenance

Occasionally, new package dependencies or schema changes will necessitate maintenance. To non-destructively update your development stack at any time:

1. Run docker compose pull
2. Run docker compose build --pull --no-cache
3. Run docker compose run --rm django ./manage.py migrate