From e285827ffec4c4747207e5e4166d16e185dfc365 Mon Sep 17 00:00:00 2001
From: Marko Mecina <marko.mecina@univie.ac.at>
Date: Thu, 25 Aug 2022 14:35:48 +0200
Subject: [PATCH] update of README and requirements.txt for improved system
compatibility and clarity
---
README | 59 ++++++++++++++++++++----------------------------
requirements.txt | 12 ++++++++--
2 files changed, 35 insertions(+), 36 deletions(-)
diff --git a/README b/README
index 0331202..f18ddc4 100644
--- a/README
+++ b/README
@@ -1,59 +1,50 @@
-This file documents the required steps to get the UVIE EGSE software up and running on a freshly installed (Arch) Linux system.
+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).
-manjaro-xfce-21.0.5 linux5.10
-
-# Prerequisites
-1) get CCS repository
+# PREREQUISITES
+1) Get CCS repository
$> git clone https://gitlab.phaidra.org/mecinam2/CCS.git
-2) install MySQL/MariaDB and set it up
+2) Required packages/devtools
+ - make
+ - python-pip
+ - gtk3
+ - python-gobject
+ - gtksourceview3 [<=3.24.11-1]
- 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
+ $> sudo mariadb-secure-installation (optional)
mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
mysql> GRANT ALL PRIVILEGES ON * . * TO 'user'@'localhost';
mysql> FLUSH PRIVILEGES;
-3) install packages/devtools
- - gtksourceview3 [<=3.24.11-1]
- - python-pip
- - make
+4) Install Python packages. To install the required modules with pip in userspace or a venv, run
+ 'make install-python-requirements' in the CCS base directory or use 'pip install [--user] -r requirements.txt'.
+ For details, see requirements.txt
+
+
+# INSTALLATION
+In the CCS base directory,
-4) install python modules (to install the required modules with pip in userspace or a venv, you can run 'make install-python-requirements' in the CCS base directory or use 'pip install [--user] -r requirements.txt')
- - ipython [=7.*]
- - python-numpy
- - python-scipy
- - python-matplotlib
- - python-cairocffi
- - python-mysqlclient
- - python-sqlalchemy
- - python-wheel
- - python-sphinx
- - python-sphinx_rtd_theme
- - python-astropy
- - python-crcmod
- - python-psutil
-
-# Installation
-In the CCS base directory, execute
-
- - first configure egse.cfg!
+ - first configure the [database] section in egse.cfg!
+ - then execute:
$> make install-confignator
$> make ccs-storage
$> make codeblockreusefeature
# MIB
-Use CCS/Ccs/tools/import_mib.py to import a set of SCOS2000 MIB files into a MySQL DB schema
+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
+./start_ccs: starts the CCS
+./start_tst: starts the TST
-# Troubleshooting
+# TROUBLESHOOTING
If working within a Python venv, you might need to install vext to access the system-site installation of gi:
pip install vext
pip install vext.gi
diff --git a/requirements.txt b/requirements.txt
index 4008252..2f00080 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -13,7 +13,15 @@ sphinx_rtd_theme
astropy
crcmod
psutil
+dbus-python
+vext
+vext.gi
-# for TASTE, which also needs libdbus-1-dev, gir1.2-notify-0.7, libgirepository1.0-dev, libgtk-3-dev
+# vext requires python-gobject to be installed on system level.
+# Alternatively, install pygobject with pip (requires gobject-introspection to be installed)
+
+# If using Conda for managing Python packages, vext might not work. Try installing PyGObject in the venv with Conda instead:
+# conda install -c conda-forge pygobject
+
+# For TASTE, which also needs libdbus-1-dev, gir1.2-notify-0.7, libgirepository1.0-dev, libgtk-3-dev:
# pygobject
-# dbus-python
--
GitLab