Installation

This manual describes how to install and configure the OSCAR-5 system.

Attention

The OSCAR-5 pre and post processing framework is intended to act as a light weight client, installed on a user’s local workstation. It has built in features that enables communication with target codes residing on other machines. Thus it is not advisable to install the entire system in a shared environment.

Getting Access to Git Repositories

All of the components of the OSCAR-5 system are hosted on private GitLab repositories. Although not required, joining a project on GitLab will give you access to:

1. An issue tracking system, where you can report bugs, make suggestions, and view other user’s as well as developer’s posts.

2. Latest bug fixes and system improvements.

3. Bleeding edge features by switching to the developer branch.

4. The ability to contribute to the system if you are a developer partner.

To join a project, please create a user account on GitLab, then email us your account name so that we can add you to the relevant groups. See Working with Git, for a quick introduction.

Installation Manuals

• Installation with Conda
  • Introduction
    • What is Anaconda and Conda?
    • What is a “conda package”?
    • What is a “conda environment”?
    • What is a “conda channel”?
    • Installing and updating conda packages
    • Initial installation procedure
  • Prerequisites
    • Anaconda3
    • Intel Fortran Redistributable Package
    • Git
  • Using the Self Contained Installer
  • Creating a Local Package Repository
  • Live Installation
    • Basic Installation
    • Python development installation
    • Manual installation without using the install script
  • Installing the License File
  • Testing Your Installation
  • Installing Optional Packages
    • FreeCAD
    • YADE
  • Configuring the IDE
    • Installation
    • Setting the interpreter
    • Customizing the terminal
    • Locating Git
  • Troubleshooting
    • Error on importing core
    • Error on visualisation
    • Error on running MGRAC
• Using a Docker Container
  • Linux
    • Step 1: Build a base image
    • Step 2: Create a container
  • Configuring a display server for Windows
  • Windows 7 & 8
    • Step 1: Install docker
    • Step 2: Build a base image
    • Step 3: Create a container
    • Starting an existing container
  • Windows 10
    • Step 1: Install and start docker
    • Step 2: Build a base image
    • Step 3: Create a container
    • Starting an existing container
• Docker cheat sheet
• Compiling from Source
  • System dependencies
    • Complete C++/C build environment
    • Python and python development package
    • Boost
    • CMake
    • High precision libraries
    • Miscellaneous
  • Additional python dependencies
    • Matplotlib
    • VTK python bindings
    • QT4 python bindings
  • Building external dependencies
    • Boost
    • CGAL
  • Building and installing the extensions
    • Pointing to local boost
  • Setup on local host
    • Setup python package management
    • Configuring a virtual environment
    • Get python virtual environment utilities
    • Creating a virtual environment
    • Complete system configuration