# Setup

## Installation
In this section, we walk through the process of setting up [`infinity-workflows`](https://github.com/toinfinityai/infinity-workflows) on a local computer so that you can start generating data. 

```{note}
This page uses instructions with [pip](https://pip.pypa.io/en/stable/), [the recommended installation tool for Python](https://packaging.python.org/en/latest/guides/tool-recommendations/#installation-tool-recommendations). You may want to install your packages into an isolated environment using tools like [conda](https://docs.conda.io/) or [venv](https://docs.python.org/3/library/venv.html). Regardless, your environment will need pip and Python 3.8+ available on your system path. 
```

Clone the [`infinity-workflows`](https://github.com/toinfinityai/infinity-workflows) repository, which includes Jupyter notebooks and helper modules for generating synthetic data.

```bash
git clone https://github.com/toinfinityai/infinity-workflows.git
```

---

```{note}
If you are using [conda](https://docs.conda.io/) you can follow the instructions below or run the [provided install script](https://github.com/toinfinityai/infinity-workflows/blob/main/install_conda_env.sh):
```bash
./install_conda_env.sh
```

Create an isolated python environment using the tool of your choice and enter it. For example, with [conda](https://docs.conda.io/), you can use the following commands:

```
conda create --name infinity python=3.9 
conda activate infinity
```
---

From within the repository directory, install the Python dependencies.

```bash
pip install -r requirements.txt --force-reinstall
```

Note that `requirements.txt` lists `infinity-core`, the python package that facilitates the Infinity API interactions. The `infinity-core` package is included in the repository.  You can read more about `infinity-core` in the [Infinity Core Package](/source/infinity_core) section.

---

From within repository directory, launch the jupyter notebook environment
```bash
./run_notebooks.sh  # This runs: 'PYTHONPATH="$(pwd)" jupyter notebook'
```
This script simply makes sure the repository's modules are part of the `PYTHONPATH` when `jupyter notebook` is launched. 

---

You have completed installation. Please proceed to the [Workflows example](workflows) to generate data.


## Upgrades 

To upgrade to the latest verion of `infinity-workflows`, pull the latest code and update your python environment.
```bash 
git pull
pip install -r requirements.txt --force-reinstall
```