1: Installation - bruno-beloff/scs_analysis GitHub Wiki
docs > software repositories > scs_analysis
Language
The scs-analysis package requires Python 3.7 or above.
Standard installation
Pip
The simplest way to install the scs_analysis package is via the pypi project:
pip install --upgrade scs-analysis
For trouble-free installation, perform the pip install using a dedicated python virtual environment. Instructions here:
venv — Creation of virtual environments
tkinter
On Linux, it may be necessary to install tkinter in order for matplotlib charts to be displayed:
sudo apt-get install python3-tk
Custom installation
Installation can be customised using pip, git and other tools.
Required libraries
Third party libraries should normally be installed using pip3
- Third party - see requirements.txt
- SCS root: scs_core
- SCS host (macOS, Linux, Windows 10): scs_host_posix
Branches
The stable branch of this repository is master. For deployment purposes, use:
git clone --branch=master https://github.com/bruno-beloff/scs_analysis.git
Software updates
The master branches of the scs_analysis and its dependent South Coast Science repositories are periodically updated. Software updates can be retrieved via git pull. To co-ordinate updates to all the South Coast Science packages, run the provided script.
Raspberry Pi, other Linux
~/SCS/scs_analysis/git_pull.sh
Windows 10 / 11
cd C:\Users\MY_ACCOUNT_DIRECTORY\SCS\scs_analysis\
git_pull.bat
Setting PYTHONPATH
The PYTHONPATH environment variable must be set in order to resolve references between the South Coast Science packages. The variable is set slightly differently, depending on operating system.
macOS
Add the following to ~/.bash_profile:
PYTHONPATH="{$HOME}/SCS/scs_analysis/src:{$HOME}/SCS/scs_host_posix/src:{$HOME}/SCS/scs_core/src:${PYTHONPATH}"
export PYTHONPATH
Raspberry Pi
Add the following to /etc/profile or /home/pi/.bashrc:
export PYTHONPATH=~/SCS/scs_analysis/src:~/SCS/scs_dev/src:~/SCS/scs_mfr/src:~/SCS/scs_dfe_eng/src:~/SCS/scs_host_rpi/src:~/SCS/scs_core/src:$PYTHONPATH
Other Linux
Add the following to ~/.bashrc:
export PYTHONPATH="${HOME}/SCS/scs_analysis/src:${HOME}/SCS/scs_host_posix/src:${HOME}/SCS/scs_core/src:${PYTHONPATH}"
Windows 10 / 11
Add the following environment variables:
| Name | Value |
|---|---|
| SCS_HOME | C:\Users\MY_ACCOUNT_DIRECTORY\SCS |
| PYTHONPATH | %SCS_HOME%\scs_analysis\src;%SCS_HOME%\scs_core\src;%SCS_HOME%\scs_host_posix\src |
The following gives information on how to set environment variables:
How do I set or change the PATH system variable?
Setting PATH
The PATH environment variable specifies the search order for directories containing command line scripts. The directory containing the scs_analysis command line utilities may be added to this.
macOS
Append the following to ~/.bash_profile:
PATH=~/SCS/scs_analysis/src/scs_analysis:$PATH
export PATH
Raspberry Pi, other Linux
Append the following to ~/.profile:
export PATH=~/SCS/scs_analysis/src/scs_analysis:$PATH
Windows 10 / 11
Add the following entry to the Path environment variable:
C:\Users\MY_ACCOUNT_DIRECTORY\SCS\scs_analysis\src\scs_analysis\