Skip to content

Installation

PassengerSim is currently available only for Mac and Linux operating systems.
Support for other operating systems is not planned for the near future.

Before you begin: install conda if needed

PassengerSim is a Python package that is most easily installed in an environment managed by conda. To check if you have conda installed, open a terminal and type conda --version. If you see a version number, you have conda.

If you have conda, but with an outdated version (i.e. less than 24), you can update it by running conda update conda.

If you don't have conda, you can install it by pasting the following command into your terminal:

curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh
bash Miniforge3-$(uname)-$(uname -m).sh

Installing PassengerSim

If you have received a file named something like install-passengersim-mac-v0.0-20240101.sh, you can use it to install PassengerSim in a conda environment. To do so, open a terminal and navigate to the directory where the file is located. Then, run the following command:

bash install-passengersim-mac-v0.0-20240101.sh

Tip

Don't copy-paste the command above, as the exact filename of the installation script will vary based on the version of PassengerSim and the release data. Instead, use the filename of the file you have received.

Changing the conda environment name

The default install will put PassengerSim in a conda environment named SKY. If you already have a conda environment named SKY, the installation script will update the environment to the relevant version of PassengerSim. If you prefer to install PassengerSim in a different environment (e.g. myenv), you can specify the environment name as an argument to the installation script:

bash install-passengersim-mac-v0.0-20240101.sh -n myenv

Running PassengerSim

After the installation is complete, you can start a Jupyter Lab session from the environment by running the following command:

conda run -n SKY jupyter lab

If you installed PassengerSim in an environment named something other than SKY, replace SKY in the command above with the name of the environment you used.

Alternative Installation: Docker

Do you have a link to a sky docker image file? If not, these are not the install instructions you are looking for. If you do have a link, go ahead and download the file. If you are installing on Windows or an Intel-based Mac, you want the amd64 image. For installing on more recent Apple Silicon-based Macs, use an arm64 image.

In addition to the image file, you'll want to download and install Docker Desktop for your computer. Once it's installed, make sure it's running (you should be able to open and see Docker's dashboard).

Then, open a console terminal and change to the directory where the docker image sky.tar file has been saved. It might be named something slightly different from sky.tar, in which case change the filename in the commands you type to match the filename of the image file you have. The first step is to run

docker load --input sky.tar

This command may take a few moments to complete, as the content of the downloaded image file will be imported into docker. You'll need several free gigabytes of hard disk space to complete this step, so if you encounter unexplained EOF errors here that may be the problem.

After the docker image is loaded, you should see a sky image in the docker desktop dashboard. If you can see it, you should then be able to start a container with this image using the following command:

docker run -p 8899:8899 --rm --volume "$(pwd)":/tmp/workplace/work sky:latest

docker run -p 8899:8899 --rm --volume "%cd%":/tmp/workplace/work sky:latest

Within this command, we have:

  • -p 8899:8899 tells docker to expose the container's port 8899 (which has been configured to be the port served by Jupyter Lab) to localhost.
  • --rm means to remove the container when it exits, so there isn't an extraneous container image file left on your file system.
  • --volume "...":/tmp/workplace/work makes the current working directory available inside Jupyter Lab in a directory named work (the container has been configured with /tmp/workplace as the base location for Jupyter).
  • sky:latest tells Docker to use the latest version of the user image that was installed in the docker load step above. If your installed docker image (as shown in the Docker Dashboard) has a different name than sky then change the command to give the corrent image name.