Install

Prerequisites

The SSD project has the following dependencies:

Package	Dependency	Type	Install
SSD.Core.Storage	Peewee	Required	pip install peewee
	Numpy	Required	pip install numpy
SSD.Core.Rendering	Vedo	Required	pip install vedo
	Open3D	Required	pip install open3d
SSD.SOFA	SofaPython3	Optional	Follow instructions

Warning

The SOFA Python bindings are not required to use the SSD.Core packages, but they are obviously required to use the SSD.SOFA.Storage and SSD.SOFA.rendering packages. Those two packages will be ignored during the installation process if SOFA Python bindings are not found by the interpreter.

Install

Install with pip

The SSD project is registered on PyPi, thus it can easily be installed using pip:

$ pip3 install SimulationSimpleDatabase

Then, you should be able to run:

$ pip3 show SimulationSimpleDatabase

import SSD

Install from sources

Start by cloning the SSD source code from its Github repository:

$ git clone https://github.com/RobinEnjalbert/SimulationSimpleDatabase.git
$ cd SimpleSimulationDatabase

Then, you have two options to install the project:

• (USERS) either by using pip to install it as non-editable in the site-packages;

  $ pip3 install .
  

• (DEVELOPERS) either by running the setup_dev.py script to link it as editable in the site-packages.

  # Create a link to SSD packages in the site-packages
  $ python3 setup_dev.py set
  
  # Remove the link to SSD packages in the site-packages
  $ python3 setup_dev.py del
  

Then, you should be able to run:

# Only if installed with pip
$ pip3 show SimulationSimpleDatabase

# In both options
import SSD