Electronic System Design Group

Utils

The following utilities are provided with FPGAFlow to aid the management of FPGAFlow on the users system.

By adding the following location to the user’s path these can be accessible from anywhere on the system:

example entry in ~/.cshrc

setenv REPO_UTILS $REPO_ROOT/tools/fpgaflow/scripts/python/utils
set path = ($REPO_UTILS $path)

pipenv_installer.py

pipenv_installer.py provides a basic method to install the required Python Modules as well as Additional Modules from $REPO_ROOT/tools without placing the addition tools in the resulting Pipfile.

Note

pipenv_installer.py will backup existing Pipfile and Pipfile.lock files.

Creating Virtual Environment

By running this command, pipenv_installer.py will remove any existing virtual environment and create a new fresh environment containing only the Python Modules. This will be represented by the resulting Pipfile.

pipenv_installer.py usage

# Installation:
pipenv_installer.py

Creating Virtual Environment with Additional Modules

By running this command, pipenv_installer.py will remove any existing virtual environment and create a new fresh environment containing the Python Modules. and the Additional Modules. The resulting Pipfile will only represent the Python Modules with no reference to the Additional Modules.

The most recent version of the additional module will be installed.

pipenv_installer.py additional module usage

# Installation with Additional Modules:
pipenv_installer.py [<MODNAME>-<ORG> [<MODNAME>-<ORG>] ..]

Note

Additional Modules must be in the form>: <MODNAME>-<ORG>.

Updating Additional Modules

By running this command, pipenv_installer.py will uninstall the specified Additional Modules from the virtual environment and install the most recent version of the additional module.

The resulting Pipfile will only represent the Python Modules with no reference to the Additional Modules.

pipenv_installer.py additional module update usage

# Updating Additional Modules:
pipenv_installer.py update [<MODNAME>-<ORG> [<MODNAME>-<ORG>] ..]

Note

• Additional Modules must be in the form>: <MODNAME>-<ORG>.
• Additional Modules can also be installed to an existing virtual environment using ths method.