---
# System prepended metadata

title: installation

---

# installation

## using conda
To install the environment and packages the best way is to use conda.

1. Download [miniconda](https://docs.conda.io/en/latest/miniconda.html).
2. Install with `sh Miniconda...`.
3. Make sure to add conda init to the path
    a. Close term & open term
4. Create a new environment with
    ```bash
    conda create -n "python3"
    conda activate python3
    conda config --add channels conda-forge
    conda config --set channel_priority strict
    ```
5. Install the necessary packages:
    ```bash
    conda install jupyter kwant jupytext  matplotlib=3.3 holoviews
    ```
6. Run a jupyter notebook: open the terminal and `jupyter notebook`
    a. if you have more than one environment, make sure to choose the right kernel on jupyter, if you don't see your kernel, use 
    `python -m ipykernel install --user --name python3 --display-name "python3"`
    where the last string is the name that will be displayed on the list of available kernels.



## using the gitlab repository
1. install `git`
2. create a GitLab account
3. join the repository
4. clone the repository
    a. if you have set up the SSH authentication use `git clone git@gitlab.com:tocha/fkm-dyn-dis.git`, and `git clone`
    b. if you are not interested in SSH, you can use the HTTPS (you will be prompted for your username and password every time) `git clone` and `git clone`.
    c. if you don't want to `git clone`, you can just download the full repository as a folder.
    
6. stay up to date (if you went for the option 4.a or 4.b) with 
    a. `git pull` # downloads the latests commits
    b. `git add file1.ext file2.ext` # stages file versions for commit
    c. `git commit -m 'a comment of what you just added'` # creates a local commit
    d. `git push` # publishes the commit to the repo

