# Get started

## Installation

DAN is published on a GitLab package registry.
You need [a personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with [scope](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#personal-access-token-scopes) `read_api` in order to install this module. You will need to add the below to your `~/.netrc` file:

```shell
machine gitlab.teklia.com
login __token__
password <YOUR_PERSONAL_TOKEN>
```

### As a dependency

To install DAN as a dependency, you need to first add the following line to your `requirements.txt` file:

```shell
--index-url https://gitlab.teklia.com/api/v4/projects/98/packages/pypi/simple
teklia-dan
```

The `--index-url` argument is required to find the `DAN` package.

Then you can install it via pip:

```shell
pip install -r requirements.txt
```

### Directly

To install DAN directly, you can install it via pip:

```shell
pip install --index-url https://gitlab.teklia.com/api/v4/projects/98/packages/pypi/simple teklia-dan
```

The `--index-url` argument is required to find the `DAN` package.

---

To learn more about the newly installed `teklia-dan` command, make sure to run:

```shell
teklia-dan --help
```

### As an editable package

For development and tests purpose it may be useful to install the project as a editable package with pip.

To install DAN as an editable package, you can install it via pip:

```shell
pip install -e .
```

Get started with:

- [Developments](development.md)
- [Training workflow](training.md)