Paths/DB - Simscope Administration Guide

Choose paths to store Simscope, the Tunnel, and its database

Simscope needs a few directories and symlinks to store files.

You can choose to store Simscope and its database either on local storage or network (ie NFS) storage.

Directories

Simscope needs a base directory, $SIMSCOPE_HOME and a few subdirectories to put your scripts, config files, and database in.

Path Name	Description	Example
`$SIMSCOPE_HOME`	Simscope base directory	`/work/simscope`
`$SIMSCOPE_BIN`	Custom scripts/plugins	`$SIMSCOPE_HOME/bin/`
`$SIMSCOPE_CONFIG`	Configuration dir	`$SIMSCOPE_HOME/config/`
`$SIMSCOPE_DB`	Database storage	`$SIMSCOPE_HOME/db/`

Symlinks

To make upgrading Simscope and the Tunnel easy, use symlinks which point to the latest release codebases.

This way the symlink always points to the latest software release, and upgrades just require untar and updating symlinks.

Path Name	Description	Example
`$SIMSCOPE`	Simscope server application (symlink)	`$SIMSCOPE_HOME/simscope-latest/`
`$SIMSCOPE_TUNNEL`	Simscope Tunnel application (symlink)	`$SIMSCOPE_HOME/tunnel-latest/`

For example, if the latest Simscope is located at:

/work/simscope/simscope-1.1000

The symlink simscope-latest should point to:

simscope-1.1000

Edit simscope-dirs.sh

Note: these paths can be set to anywhere on disk.

# Instructions:
# > EDIT THIS FILE AND MOVE THIS FILE TO $SIMSCOPE_HOME/bin

# Docs:
# > https://admin-docs.simscope.com/quickstart/paths.html

# To use this:
# > source simscope-dirs.sh

# ================================================================================
# Simscope Paths
export SIMSCOPE_HOME=/work/simscope # REPLACE WITH YOUR Simscope installation base directory

export SIMSCOPE=$SIMSCOPE_HOME/simscope-latest
export SIMSCOPE_TUNNEL=$SIMSCOPE_HOME/tunnel-latest

export SIMSCOPE_CONFIG=$SIMSCOPE_HOME/config
export SIMSCOPE_DB=$SIMSCOPE_HOME/testdb
# ================================================================================

With this, you can source simscope-dirs.sh from any script to set up your environment variables.

library files

Simscope uses a few Linux libraries including libsnappy. These are bundled with Simscope in the dist/ subdirectory.

If they are not found, you will get an error similar to the following:

error while loading shared libraries: libsnappy.so.1: cannot open shared object file: No such file or directory

To use the bundled libraries at runtime without installing onto your system, make sure LD_LIBRARY_PATH=$SIMSCOPE/dist is prefixed before your command.

For example:

> LD_LIBRARY_PATH=$SIMSCOPE/dist $SIMSCOPE/bin/simscope