ccs

This file documents the required steps to get the UVIE EGSE software up and running on a freshly installed Linux system (tested on manjaro-xfce-21.3.7 linux5.15).

# PREREQUISITES
1) Get CCS repository
    $> git clone https://gitlab.phaidra.org/mecinam2/CCS.git
    
2) Required packages/devtools
    - make
    - gtk3
    - gtksourceview3
    - python-pip
    - python-gobject
    - dbus-python
    - mariadb
    - mysql-workbench (optional)

3) Initialise MySQL/MariaDB and set it up

    $> sudo mariadb-install-db --user=mysql --basedir=/usr --datadir=/var/lib/mysql
    $> sudo systemctl enable --now mariadb
    $> sudo mariadb-secure-installation  (optional)

    To create a MariaDB user, in the CCS base directory execute

    $> make db-user USER=<user> PW=<password>

    Alternatively, execute the following SQL statements:
    mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
    mysql> GRANT ALL PRIVILEGES ON * . * TO 'user'@'localhost';
    mysql> FLUSH PRIVILEGES;

4) Install Python packages. To install the required modules with pip in userspace or a venv, run
   'make python-requirements' in the CCS base directory or use 'pip install [--user] -r requirements.txt'.
   If using a venv, it must have been created using the --system-site-packages option.
   For more details, see requirements.txt
   Since Python 3.11, pip --user installs of packages are denied by default to avoid conflicts with
   system-managed packages - the recommended solution is to use a venv. Alternatively, installing in
   local userspace is still possible by passing the --break-system-packages flag.


# INSTALLATION
In the CCS base directory,

    - first configure the [database] section in egse.cfg!
    - then execute:
    
    $> make confignator
    $> make databases
    
# MIB
Use CCS/Ccs/tools/import_mib.py to import a set of SCOS2000 MIB files into the MySQL mib-schema set in egse.cfg

# CCS & TST
./start_ccs: starts the CCS
./start_tst: starts the TST

# INSTALLATION ON MAC
The CCS tools should generally also work on a Mac, the installation process will require some modifications and/or additional steps, however.

- it is recommended to use a Python venv (with system-site packages enabled):
    python3 -m venv ve_ccs --system-site-packages

- some additional (Python) packages may need to be explicitly installed:
    pip install setuptools
    brew install libnotify
    brew install pkg-config
    brew install gtk+3
    pip install dbus-python==1.2.18
    brew install python-argcomplete

    brew install openssl
    export LDFLAGS="-L$(brew --prefix openssl)/lib"
    export CPPFLAGS="-I$(brew --prefix openssl)/include"
    export PKG_CONFIG_PATH="$(brew --prefix openssl)/lib/pkgconfig"

    pip install mysqlclient

- potentially, versions have to be specified for some packages in requirements.txt (sqlalchemy==1.4, ipython==7.12.0)