Install Odatix from sources¶
Step 1: Clone the repository¶
sudo apt update
sudo apt install -y git
git clone https://github.com/jsaussereau/Odatix.git
cd Odatix/
sudo dnf update
sudo dnf install -y git
git clone https://github.com/jsaussereau/Odatix.git
cd Odatix/
sudo pacman -Syu
sudo pacman -S git --noconfirm
git clone https://github.com/jsaussereau/Odatix.git
cd Odatix/
Caution
Windows is not an officially supported platform for Odatix yet. However, some functionalities may work.
Download and install Git from the git official website or via winget:
winget install --id Git.Git -e --source winget
Important
Restart your terminal after installing git to be able to use the git command.
Then, clone the repository and navigate to it:
git clone https://github.com/jsaussereau/Odatix.git
cd .\Odatix
Step 2: Install Python 3.6+ and make¶
sudo apt update
sudo apt install -y python3 python3-pip python3-venv make
sudo dnf update
sudo dnf install -y python3 make
sudo pacman -Syu
sudo pacman -S python3 make --noconfirm
Download and install Python the Microsoft Store, or from the python official website, or install it via winget:
winget install --id Python.Python.3 -e
Warning
If you install Python from the python official website, make sure to check the box “✅ Add Python to PATH” during the installation.
Important
Restart your terminal after installing python to be able to use the python command.
Step 3: Configure a virtual environment [Optional]¶
If you want to use Odatix inside a virtual environment, run:
# Create a virtual environment
python3 -m venv odatix_venv # You only need to do it once
# Create a virtual environment
python3 -m venv odatix_venv # You only need to do it once
# Create a virtual environment
python3 -m venv odatix_venv # You only need to do it once
# Create a virtual environment
python -m venv odatix_venv # You only need to do it once
To activate the virtual environment, run:
# Activate the virtual environment
source odatix_venv/bin/activate
# Activate the virtual environment
source odatix_venv/bin/activate
# Activate the virtual environment
source odatix_venv/bin/activate
# Activate the virtual environment
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\odatix_venv\Scripts\Activate.ps1
Note
You have to run this command at every new shell session. Consider creating an alias
Step 4: Install the package¶
Depending of if you want to install Odatix in editable mode or not:
Option #1: Install Odatix in editable mode¶
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -e ./sources
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -e ./sources
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -e ./sources
python -m pip install --upgrade pip setuptools wheel
python -m pip install -e .\sources --use-pep517
Option #2: Install Odatix without editable mode¶
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install ./sources
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install ./sources
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install ./sources
python -m pip install --upgrade pip setuptools wheel
python -m pip install .\sources --use-pep517
Step 5: Enable option auto-completetion [Optional]¶
If you want to enable autocompletion of odatix command options, you can run:
eval "$(register-python-argcomplete odatix)"
eval "$(register-python-argcomplete odatix-explorer)"
Note
You have to run these commands at every new shell session.
Consider adding these to your odatix_venv/bin/activate (if using a virtual environment) script or your .bashrc / .zshrc
Step 6: Install one of the supported EDA tools¶
More information in section Install one of the supported EDA tools.