Skip to content

Installing SCUBAS

Install and Configure SCUBAS

Setup guidance for Python environments, dependencies, and optional geospatial tooling used in submarine cable modeling workflows.

License: MIT Python 3.11 GitHub Stable Release (latest by date) Documentation Status codecov

Important

It is recommended to install scubas pip; however, please cite via the DOI for the release

Prerequisites

scubas requires python 3.11 or later and matplotlib 3.3.4 or later.

Depending on your operating system or distribution, the following package installers, development environments or data parsers are required:

Ubuntu OpenSuse Fedora OSX Windows
libyaml-dev python3-PyYAML libyaml-devel Xcode/pip pip

You can check your python version using

$ python --version or $ python3 --version

Note

If you have already installed scubas you can use pip3 install --upgrade scubas

Dependencies

scubas's setup will download the following dependencies:

Note

If you wish to plot coastlines or geographic projections you will need to install cartopy>=0.19 separately

Cartopy

Cartopy is a Python package designed for geospatial data processing in order to produce maps and other geospatial data analyses. This library is used when invoking a projection system needing overlapped coastline maps in cable routs plots.

For installing cartopy please follow the packages installation instructions. For ubuntu here is good installation link

Warning

For cartopy to work with scubas please make sure it version >=0.19. Otherwise scubas will throw an exception if you try to use it.

Note

cartopy can be a challenging package to install so please provide any information on troubleshooting or solutions to common issues on the SCUBAS GitHub page.

Virtual Environments

It is recommended to install scubas in one of the suggested virtual environments if you have multiple python/pip 3 version on your computer, or do not want to affect the main system's python libraries.

The following virtual environments have been tested by scubas developers:"

pip Virtual Environment

Instructions can be found here virtual environment

  1. $ python3 -m pip install --user virtualenv (Install virtual environment package)
  2. $ python3 -m virtualenv <environment name> (Make your virtual environment)
  3. $ source <environment name>/bin/activate (Activate the virtual environment)
  4. $ pip install scubas (Install scubas)

Note

If you have multiple versions of python 3 on your machine, you can access a specific version by: python<version number>. For example, if you want to install python 3.6 virtual environment: python3.6 -m pip install --user virtualenv.

Anaconda Virtual Environment

Instructions can be found here conda environment and installing anaconda

  1. $ conda create -n yourenvname python=3.7 anaconda
  2. $ conda activate yourenvname
  3. $ pip install scubas

Adding the environment to PyCharm

To set the project interpreter to the anaconda environment:

  1. File -> Settings -> Project Folder -> Project Interpreter

  2. Click the project Interpreter drop down list and click on show all.

    • If you don't see the environment you wish to use click the plus sign on the right side bar named "Add"
    • Select "Conda Environment" on the left side menu.
    • Click "Existing Environment" and give the interpreter field the path to your environment's python.exe and apply.

Local Install

pip3 install

pip3 install --user scubas

System Install

sudo pip3 install scubas