Install the Sciagraph report viewer

In order to view profiling reports that you haven’t stored yourself, you will need to install the sciagraph-report tool. The tool should run on Linux, macOS, and Windows, and requires Python 3.7 or later.

In general, you can install it by doing pip install sciagraph-report. More specifically, you can do so in a number of ways.

  • If you have a virtual environment created with virtualenv, python -m venv, or conda env, you can install the package into that environment by simply running pip install sciagraph-report inside the activated virtualenv.
  • You can install as a “user” install: pip install --user sciagraph-report. This installs the package in a user-specific location. Newer versions of pip will do user installs automatically when running outside of a virtualenv; older versions will require an explicit --user flag.
  • You can install sciagraph-report using the pipx tool, which is designed for isolated installs of Python command-line tools.

In theory you can also install it globally to the whole machine (sudo pip install ... on Linux or macOS), but since you’ll be installing on your development machine this is a bad idea. In general, you should never sudo pip install.

Troubleshooting

If you get a ERROR: Can not perform a '--user' install. User site-packages are not visible in this virtualenv. that means you tried to do pip install --user inside a virtualenv. Just run pip install sciagraph-report, omitting the --user.