🛠 Installation¶

To begin with, install a Python version >=3.9,<3.13.
A working Fortran Compiler (gfortran) is also required. If you do not have gcc installed, the following commands depending on your operating system will take care of this requirement. Please note that installing gcc sometimes might take couple minutes ⏳ 🤦‍♂️. You can also check the standalone gfortran installers here.
```
# Mac Users
brew install gcc

# Linux Users
sudo apt install build-essential gfortran
```
Now, to install the library from PyPI simply run 🏃‍♀️ :
```
pip install slickml
```
or if you are a uv user, simply run 🏃‍♀️ :
```
uv add slickml
```
The SlickML does come with CLI tool which behaves similarly to many other CLIs for basic features. In order to find out which version of SlickML you are running, simply run 🏃‍♀️ :
```
slickml --version | -v | version
```
If you ever need more information on exactly what a certain command will do, use the --help or -h command. For example, to see all available commands, simply run 🏃‍♀️ :
```
slickml --help | -h
```
In order to avoid any potential conflicts with other installed Python packages, it is recommended to use a virtual environment, e.g. uv, python virtualenv, pyenv virtualenv, or conda environment.
We highly recommend managing your projects using uv. All SlickML developments are done via uv. To begin with, first install uv following the installation documentation depending on your operating system.
Once uv is installed, sync the project dependencies from uv.lock 🏃‍♀️ :
```
uv sync
```