vascpy requires Python version 3.7 or higher. It is recommended to create a virtual environment in order to install the package.

Virtualenv setup

In following code samples, the prompts (venv)$ and $ are used to indicate that the user virtualenv is activated or deactivated respectively.

$ python3 -mvenv venv       # creates a virtualenv called "venv" in the current directory
$ source venv/bin/activate  # activates the "venv" virtualenv
(venv)$                     # now we are in the venv virtualenv

Upgade the pip version as shown below:

(venv)$ pip install --upgrade pip   # Install newest pip inside virtualenv if version too old.

To de-activate the virtualenv run the deactivate command:

(venv)$ deactivate

Note that you do not have to work in the venv directory. This is where python packages will get installed, but you can work anywhere on your file system, as long as you have activated the virtualenv.

Installation options

Install from the official PyPI server

Install the latest release:

pip install vascpy

Install a specific version:

pip install vascpy==0.1.0

Install from git

Install a particular release:

pip install git+

Install the latest version:

pip install git+

Install from source

Clone the repository and install it:

git clone
pip install -e ./vascpy

This installs vascpy into your virtualenv in “editable” mode. That means that changes made to the source code after the installation procedure are seen by the installed package. To install in read-only mode, omit the -e.