!!! warning "Pre-requisites" 
    - Your machine has **Python (>=3..10)** installed   
    - You have a **.env file** properly configured (see [here][getting-started] if needed)

!!! info
    Going forward, we will refer to an **InfamousRepo** to designate:
    
    - either a clone of the original cea-infamous repo   
    - or a clone of your own fork of the original cea-infamous repo

Even if we obsviously encourage you to work with an **InfamousRepo**, you can choose to use djagigit on any python environment.   

So here is how to install the beast:

???+ warning "Apple Silicon" 
    **The tableauhyperapi package doesn't work on Apple Silicon systems** (ie M1, M2.. chips)   
    Therefore it won't be installed on such systems and you won't be able to use methods that use this package (see [here](tableau.md) for more)

## Automated install
If you have an InfamousRepo on your machine, you only have to use the tools provided in the repo.   
You have 2 options :  

- Create a new project in the repo, use the [init_new_project][initializing-a-new-project] tool.   
- Create only the python virtual environment with djagitit, use the [create_env.sh][create-a-virtual-environment] tool

## Manual install
!!! note
    If you already have the python virtual environment you want to use, skip directly to the [package](#package) section

### Python virtual environment
Let's say we want to create a brand new python environment called ```queensbridge-env```
!!! success "Follow these steps"
    + Open a terminal   
    +    
    ```
    python3.10 -m venv PATH_TO_YOUR_ENV_DIRECTORY/queensbridge-env
    ```
    where ```PATH_TO_YOUR_ENV_DIRECTORY``` is the local path to a folder of your choice   
    + Congrats!
### Package
To install the djagitit package in your ```queensbridge-env``` environment    
!!! success "Follow these steps"
    === "Mac Os / Linux"
        + From the [cea-infamous repo](https://github.com/SME-BUS/cea-infamous/tree/main/packages/dist), download the   lastest version available of a ```djagitit-X.X.X-py3-non-any.whl``` file
        + Open a terminal   
        + Activate your ```queensbridge-env``` environment   
        ```
        source PATH_TO_YOUR_ENV_DIRECTORY/queensbridge-env/bin/activate
        ```
        where ```PATH_TO_YOUR_ENV_DIRECTORY``` is the local path where the environment is located   
        + install the package
        ```
        pip install YOUR_PATH/djagitit-X.X.X-py3-non-any.whl
        ```
        where ```YOUR_PATH``` is the local path where the file is located   
        + Congrats! You're done!
    === "Windows"
        + From the [cea-infamous repo](https://github.com/SME-BUS/cea-infamous/tree/main/packages/dist), download the   lastest version available of a ```djagitit-X.X.X-py3-non-any.whl``` file
        + Open a terminal (we suggest using git bash, but you can also use porwershell)
        + Activate your ```queensbridge-env``` environment   
        ```
        # with git bash, run:
        source PATH_TO_YOUR_ENV_DIRECTORY/queensbridge-env/Scripts/activate
        # or alternatively with powershell:
        PATH_TO_YOUR_ENV_DIRECTORY\queensbridge-env\Scripts\Activate.ps1
        ```
        where ```PATH_TO_YOUR_ENV_DIRECTORY``` is the local path where the environment is located   
        + install the package
        ```
        pip install YOUR_PATH\djagitit-X.X.X-py3-non-any.whl
        ```
        where ```YOUR_PATH``` is the local path where the file is located   
        + Congrats! You're done!