1. Installation

1.1. Standalone Windows installer

A standalone installer for windows allows for a simple and fast installation, but may require more disk space, does not allow to overwrite internal plugins, and does not allow to add additional python libraries. You will still be able to include custom plugins and inherit from internal plugins.

1.2. From PyPi

Install directly from the Python Package Index using pip. It is highly recommended to use virtual environments, which isolate the installed packages from the system packages:

pip install esibd-explorer

Run the program using:

python -m esibd.explorer

1.3. From source (Miniconda)

Install Miniconda or another conda distribution following the instructions on the website. You may need to manually add the paths to the following folders to the PATH environment variable.
The installation path may vary on your system. Also give the user account full write access in the Miniconda3 folder.

Download the source from github, go to the setup folder, and run create_env.bat to install all dependencies. Later, update_env.bat can be used to update dependencies. Start the program using start.bat. If desired, you can add a shortcut to start.bat to the start menu.

1.4. From source (Miniconda offline)

To install on a computer that is offline, create and export the esibd environment from another computer that is online. All files you need to do this are in the setup folder.

  1. Run create_env.bat to create the esibd environment.

  2. Run create_esibd_offline.bat to export the esibd environment as esibd.tar.gz.

  3. Install Miniconda on the offline computer and extract the content of esibd.tar.gz as a local environment.

  4. Run start_esibd_offline.bat to start ESIBD Explorer on the offline computer

You need to adjust the filepaths in these files depending on the location of the environment and software on your computer. See comments within the files for more details.

1.5. From PyPi (Linux)

While ESIBD Explorer is not developed for Linux, most features should work just as on Windows. Installation on Ubuntu 24.04.1 was possible using the following commands. Some additional dependencies and configurations may be necessary depending on your Linux distribution.

sudo apt update
sudo apt-get install python3.12-venv
sudo apt install libxcb-cursor0
python3.12 -m venv esibd

Set the include-system-site-packages to true in esibd/pyvenv.cfg

source esibd/bin/activate
pip install esibd-explorer --user
python -m esibd.explorer --disable-gpu

1.6. From source (other)

Instead of using Miniconda you can create an environment with any other python package manager of your choice and install the packages defined in esibd.yml independently. Refer to the installation instructions specific to your package manager, then follow instructions above to run ESIBD Explorer.