Table of contents
Dependencies
Required Dependencies
-
Redis Server - This is a system level installation and is installed via the system package manager, i.e. apt / yum etc. The example below is for Ubuntu based systems.
sudo apt install redis-server
-
Python 3.10+
Optional Dependencies
- Nsight Systems - If you would like to open .nsys-rep files directly in the IDE, you need nsys installed on your system
Installing the VSCode / Cursor Extension
Step 1: Open the Extensions Tab 0:00
- Launch your code editor (Cursor or VS Code).
- Locate and click on the Extensions tab in the sidebar.
Step 2: Search for the Extension
- In the Extensions tab, use the search bar to look for nCompass Performance Optimization IDE.
Step 3: Install the Extension
- Once you find the extension, click on the Install button to add it to your editor.
Step 4: Verify Installation 0:19
- After installation, check for the message: Trace Viewer Loaded Successfully.
- This message confirms that the extension has been successfully installed.
Note: Local vs Remote Installation
- The installation process is the same for both local and remote machines.
- If you are on a remote machine, the extension will install directly on that machine.
https://www.loom.com/share/b7771756dfe947a8aeb747cf88182391
Setting up the extension backend
**1. Start the Back End **0:10
- Open the command palette by pressing
Command + Shift + P.
- Search for
Start Profiler Backend to start the back end.
3. Check Installation Logs 0:21
- After starting the back end, monitor the logs that appear.
- Ensure that Python and Redis are installed on your machine for proper functionality.
4. Confirm Back End Status 0:30
- Once the back end is running, you will receive a notification.
- To verify the status, search for
Backend Service Manager in the command palette. This will list all the services launched and their status
https://www.loom.com/share/ca0de54600b942e2be01d0b009de22cf