2.4 project-setup

SYNOPSIS

project-setup [options] [project]

DESCRIPTION

Creates or updates a Simics project for user scripts and modules. If project directory is omitted, the current working directory is used.

The host Python path to be used in the project can be set via the --python command line parameter or via the SIMICS_PYTHON environment variable. If any of these are set, a Python virtual environment is also created and all necessary Python packages are installed into it, unless --no-venv is specified. The generated project scripts will use the Python in the virtual environment, or the specified Python directly if --no-venv is specified. To make sure Python packages required by the legacy Simics GUI are also installed, use the --with-gui command line parameter.

OPTIONS

-h, --help

Show help message and exit.

-v, --version

Prints information about Simics (version, installation directory).

-V, --verbose

Print more information about the actions taken by the script.

-n, --dry-run

Execute normally, but do not change or create any files.

--ignore-existing-files

Suppress warnings when creating a new project using a directory that is not empty.

--package-list

Provide an explicit list of add-on packages for the project. Each line must be an absolute path for an add-on package. A project-local .package-list file will be created.

--python

Path to the host Python binary to be used by all Simics executions in the project. If not set, the SIMICS_PYTHON environment variable is read to obtain the host Python path. If neither is set, no host Python is used and package 1033 must be available.

--no-venv

Do not create a Python virtual environment in the project.

--ignore-cygwin-warning

(Windows-only) Prevent the script from checking whether the project directory looks like a Cygwin path or not.

--force

Force the project-setup script to create or update a project. Files that would be overwritten will be backed up automatically.

--check-project-version

Check the version of the project, and return 1 if it needs to be created or updated, 0 otherwise.

--with-cmake

Create a project with CMake support.

--without-cmake

Create a project without CMake support (Default).

--with-gmake

Create a project with GNU Make support (Default).

--without-gmake

Create a project without GNU Make support.