Skip to content

1. Dependencies

Jump to bottom
Román Cárdenas edited this page Jun 30, 2022 · 12 revisions

Instructions for Windows Users

Cygwin

Our software is meant to run on UNIX-like systems. If you want to run our software on Windows, we strongly recommend you to use the Cygwin DLL. Further instructions about how to install and use Cygwin can be found here.

Command Line Tools

We need some developer tools to use Cadmium 2. After installing Cygwin, open a Windows terminal (type cmd on your Windows search) and insert the following commands:

cd c:\\cygwin64
setup-x86_64.exe -q -P chere -P wget -P gcc-g++ -P make -P diffutils -P libmpfr-devel -P libgmp-devel -P libmpc-devel -P git -P cmake

Instructions for MacOS Users

Open a terminal and insert the following command:

xcode-select –install

A software update popup window will appear asking for permission to install the command line developer tools. Click “Install” to download them and agree to the Terms of Service (after reading them, of course).

Instructions for Linux Users

Open a terminal and insert the following commands:

sudo apt update
sudo apt install build-essential make cmake git

We assume that you are using the Ubuntu distro of Linux. If you use another distro (e.g., Debian or CentOS), you may have to adapt the commands to the proper package manager (e.g., in CentOS you will use yum instead of apt).

Additional Dependencies for Developers

If you want to develop or maintain the Cadmium 2 framework, you will need to develop good-quality tests to ensure that your changes do not break anything and that the new functionalities actually work. Tests are automatically executed on GitHub for new commits in the devel and main branches. We develop tests using the Boost.Test library. Boost is a set of useful libraries for C++ programs.

Installing Boost For Windows Developers

  1. Run Cygwin on your desktop, in administrator mode (right-click on the desktop icon and select the option “Run as administrator”; we can also use c:\cygwin64 and run the script cygwin.bat in Administrator mode). The skeleton files will be created.
  2. Type the following commands:
wget rawgit.com/transcode-open/apt-cyg/master/apt-cyg
install apt-cyg /bin
chere -i -t mintty -s bash
apt-cyg install libboost-devel

Installing Boost For MacOS Developers

We strongly recommend installing Boost using the Homebrew package manager. To do so, insert the following commands in a terminal:

/usr/bin/ruby –e “$(curl –fsSL https://raw.githubusercontent.com/Homebrew/install /master/install)”
brew install boost

Installing Boost For Linux Developers

Open a terminal and insert the following command:

sudo apt install libboost-all-dev

We assume that you are using the Ubuntu distro of Linux. If you use another distro (e.g., Debian or CentOS), you may have to adapt the commands to the proper package manager (e.g., in CentOS you will use yum instead of apt).

Clone this wiki locally