1.1. Setup#

Hint

If you already setup your SimBricks environment, you can immediately proceed by configuring your first virtual prototype

The examples within the Examples repository utilize SimBricks Cloud version. To run them as-is, you will need access SimBricks Demo Backend (or your own if already present).

Do get access to SimBricks Demo Backend, start by registering for the SimBricks Demo. The registration ensures you have the proper credentials to interact with the Backend. This is necessary to send your virtual prototypes to our Backend such that the virtual prototypes execution will be scheduled on one of our Runners.

Once You got access to our Backend, you can proceed by cloning our Examples Repository:

git clone git@github.com:simbricks/simbricks-examples.git
cd simbricks-examples

After cloning and entering the examples repository, we advise to set up a Python Virtual Environment. You can create and activate a virtual environment as follows:

python3 -m venv venv
source venv/bin/activate

After the creation of your SimBricks demo account, you will need to adjust the simbricks-client.env file located in the top-level directory of the demo repository. This is necessary to ensure your SimBricks environment is correctly configured to interact with SimBricks Backend, you need to set some environment vaiables that are used by the SimBricks CLI and Client to communicate with the Backend. Do the following:

  • Open the simbricks-client.env file.

  • Locate the line that sets the NAMESPACE variable.

  • Replace <your demo email address> with the email address you used to create your demo account.

Once you’ve updated the simbricks-client.env file, you need to source the simbricks-client.env file in order to set the necessary environment variables. This can simply be done by running the following command:

source simbricks-client.env

The last required setup step is to install required SimBricks Python Packages. To run the examples given in the repository (or your own virtual prototypes), the following SimBricks packages are required:

  • simbricks-orchestration: For creating virtual prototype configurations as shown in the following.

  • simbricks-client: For sending configurations to the SimBricks server via Python.

  • simbricks-cli: For managing configurations via the terminal CLI.

You can conveniently install these packages using pip and the requirements.txt file we provide with the examples repository:

pip install -r requirements.txt

With the above steps completed, you are ready to dive into using SimBricks.

If you encounter any issues, feel free to reach out to us directly.

This Page