About

CI generating conda packages and conda-based CI tools for SOFA. Packages are uploaded on the Anaconda channel sofa-framework.

Only SOFA release are generated for now (no nightly or development versions).

Conda package build status

Available conda packages

SOFA core

Name	Version	Platforms	Description
			SOFA core runtime libraries
			SOFA core development files (runtime libraries + headers + cmake files)
			SOFA.GL rendering library (devel version)
			Qt based GUI library for SOFA (devel version)
			SOFA runtime binaries (sofaRun) + required resources. Includes all SOFA core packages.

External SOFA plugins

Name	Version	Platforms	Description
			Python bindings and scenes support. For macOS users, please read special instructions here.
			SOFA Template Library
			Plugin to Reduce Model
			Plugin implementing Kirchhoff rods to simulate any 1D flexible structure
			Plugin containing components & method for soft robotics
			Plugin to simulate linear structures using Cosserat theory

Installing SOFA from conda

Quick install (recommanded)

Full SOFA core install with SofaPython3 plugin

conda install sofa-app sofa-python3 --channel sofa-framework

Or

Full SOFA core install with all packaged plugins

conda install sofa-app sofa-python3 sofa-stlib sofa-modelorderreduction sofa-beamadapter sofa-softrobots sofa-cosserat --channel sofa-framework

Custom install

Setup conda (if necessary)

Install miniforge conda distribution

If you are new to conda or do not have a recent conda version, consider installing miniforge available here. Miniforge is a conda distribution maintened by the conda-forge community, which is the most active open-source conda community. Miniforge is also preconfigured to use the conda-forge channel by default.

Create & activate conda environment

conda create -n sofa-env
conda activate sofa-env

Install SOFA packages

You can install each of the previously mentioned package using conda command-line by specifying the sofa-framework custom channel. For example, if you want to install only SOFA runtime libraries, i.e. the libsofa package, use:

conda install libsofa --channel sofa-framework

or use the alternative modern notation:

conda install sofa-framework::libsofa

It is possible to list all the versions of each SOFA package that are available for your platform using conda search command. For example, searching versions for the libsofa package:

conda search libsofa --channel sofa-framework

Special instructions for macOS users

There is a bug with the python / libpython version provided by conda and current SofaPython3 (see this issue or related PR).

If you need to use the runSofa executable with SofaPython3 plugin, use the provided runSofa_with_python script (installed in the bin/ directory as well) instead the classical runSofa.