Skip to content

ProgrammableMatterProject/VisibleSim

Repository files navigation

VisibleSim

Getting Started

A User Manual and a Technical Reference are available in the doc directory, to get users and contributors started with VisibleSim.

Installation

Dependencies:

  • GLUT
  • GLEW
  • SBCL - to compile Meld programs
  • MUPARSER - to use CSG

Compilation

VisibleSim is written in C++17 and therefore requires a compatible compiler such as gcc9 or a recent version of clang.

Installing Submodules

There are a number of other repositories included as git submodules in VisibleSim and used as utilities (e.g. a configuration generator). They need to be fetched from their respective repositories before they can be used. This can be done with the following commands, from the project's root:

git submodule init
git submodule update

Mac Installation

1. Install dependencies:

brew install freeglut
brew install glew
brew install sbcl
brew install muparser

[Optional]
brew install ffmpeg # for video export
brew install sfml # for BlinkyBlocks sound simulation

2. make

Ubuntu Installation

1. Install dependencies:

sudo apt-get install build-essential
sudo apt-get install freeglut3-dev
sudo apt-get install libglew-dev
sudo apt-get install sbcl
sudo apt-get install libmuparser-dev

# [Optional]
sudo apt-get install doxygen # for html documentation 
sudo apt-get install ffmpeg # for video export
sudo apt-get install libsfml-dev # for BlinkyBlocks sound simulation

2. make