> For the complete documentation index, see [llms.txt](https://medomicslab.gitbook.io/mediml-app-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://medomicslab.gitbook.io/mediml-app-docs/quick-start.md).

# Quick start

## . SeeAutomatic installation

Below are tutorials for downloading and installing the app on various operating systems.

{% tabs %}
{% tab title="Windows" %}
{% embed url="<https://youtu.be/i6w9op4iNk8>" %}
{% endtab %}

{% tab title="Ubuntu" %}
{% embed url="<https://youtu.be/p4oq58PLA28>" %}
{% endtab %}

{% tab title="MacOS" %}
{% hint style="warning" %}
This tutorial is for MEDomics (the parent app) and will be updated soon, but the instructions remain the same. However, please use the following link to download the assets for the MEDiml-app: [MEDiml-app release](https://github.com/MEDomics-UdeS/MEDimage-app/releases/tag/v0.0.1).
{% endhint %}

{% embed url="<https://www.youtube.com/watch?ab_channel=MEDomicsLab&v=J9wq_C6PHK0>" %}
{% endtab %}
{% endtabs %}

## Manual installation

To manually download, install, and start using the application, please follow these steps:

#### Cloning the project

Via SSH (recommended)

```
git clone -b develop git@github.com:MEDomicsLab/MEDiml-app.git
```

Via HTTPS

```
git clone -b develop https://github.com/MEDomicsLab/MEDiml-app.git
```

#### Installing [npm ](https://www.npmjs.com/)packages

Access the cloned folder

```
cd <.../MEDiml-app/>
```

Install npm packages

```
npm install
```

#### Building [Go server](https://go.dev/) files

Manually

```
cd go_server
go build main.go
```

or automatically, by running the following script

{% tabs %}
{% tab title="Windows" %}

```
.\utilScripts\pack_GO.bat
```

{% endtab %}

{% tab title="Ubuntu" %}

```
bash utilScripts/pack_GO_linux.sh
```

{% endtab %}

{% tab title="MacOS" %}

```
bash utilScripts/pack_GO_mac.sh
```

{% endtab %}
{% endtabs %}

Set up the Python environment by running the following script

{% tabs %}
{% tab title="Windows" %}

```
.\pythonEnv\create_conda_env_win.bat
```

{% endtab %}

{% tab title="Ubuntu" %}
Run the following script

```
bash pythonEnv/create_conda_env_linux.sh
```

{% endtab %}

{% tab title="macOS" %}

```
zsh pythonEnv/create_conda_env_mac.sh
```

{% endtab %}
{% endtabs %}

This will create a [conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) named `med_conda_env` and install the required packages.

***

*When developing Python code, you may need to install new packages. To do so, you can activate the environment and install any package with pip:*

```
conda activate med_conda_env
pip install <package_name>
```

***

### RUN THE APP

```
npm run dev
```

**Now that the app is live and running, it is time to learn how to use the interface. See you on the next page.** :wink:


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://medomicslab.gitbook.io/mediml-app-docs/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.