Installation
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.
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 (follow instructions for your respective python distribution). Install using:
pip install esibd-explorer
or:
python -m pip install esibd-explorer
Run the program using:
python -m esibd.explorer
From source (Miniconda)
Miniconda3
Miniconda3\Scripts
Miniconda3\Library\bin
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.
Portable installation (offline)
To install on a computer that is offline (or if other installation approaches fail), create and export the esibd environment from another computer that is online and has the same operating system. All files you need to do this are in the setup folder. See comments within the files for more details. You do not need to install conda or python on the offline computer for this to work, all dependencies are already included.
On the online PC:
Check if the latest release already comes with a precompiled version for your system.
If you need custom requirements, add them to
create_esibd_offline.bat
Run
create_esibd_offline.bat
to create and export the esibd environment locally asesibd.tar.gz
.
On the offline PC:
Extract the content of
esibd.tar.gz
asesibd.tar
.Extract the content of
esibd.tar
asesibd
.Adjust the filepath to the
esibd
folder instart_esibd_offline.bat
.Run
start_esibd_offline.bat
to start ESIBD Explorer.
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
sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
python -m esibd.explorer --disable-gpu
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.