Set up

The purpose of this guide is to set up your system to work with the Open Autonomy framework. All the remaining guides assume that you have followed these set up instructions.

Requirements

Ensure that your machine satisfies the following requirements:

Python >= 3.8 (recommended >= 3.10)
Pip
Pipenv >=2021.x.xx
Docker Engine
Docker Compose

Additionally, if you wish to deploy your service in a Kubernetes cluster:

Tip

Although we will use these tools for demonstration purposes only, you might as well consider other local Kubernetes cluster options like kind, or even additional tools like Skaffold or Helm to help you with your cluster deployments.

Set up the framework

Create a workspace folder:
```
mkdir my_workspace
cd my_workspace
```
We recommend that you use a Pipenv virtual environment in your workspace folder. Remember to use the Python version you have installed. Here we are using 3.10 as reference:
```
touch Pipfile && pipenv --python 3.10 && pipenv shell
```
Install the Open Autonomy framework:
```
pip install open-autonomy[all]
```
Initialize the framework to work with the remote IPFS registry by default. This means that when the framework will be fetching a component, it will do so from the remote registry:
```
autonomy init --remote --ipfs
```
If you had previously initialized the framework, you need to use the flag --reset to change the configuration.
Initialize the local registry:
```
autonomy packages init
```
This will create an empty local registry in the ./packages folder. If you plan to execute the tutorial guides, you need to populate the local registry with a number of default components.

The registries and runtime folders

As seen above, the framework works with two registries:

The remote registry, where developers publish finalized software packages, similarly as Docker Hub images.
The local registry, which stores packages being developed (dev), or fetched from the remote registry (third_party) to be used locally.

Additionally, when running agents or service deployments locally, we recommend that you fetch them outside the local registry. This is because the framework will download any required component (or create auxiliary files and folders) within the runtime folders of agents and services. Therefore, we recommend that you keep the copies on the local registry clean to avoid publishing unintended files (e.g., private keys) on the remote registry.

This is roughly how your workspace should look like:

Tip

You can override the default registry in use (set up with autonomy init) for a particular command through the flags --registry-path and --local. For example, if the framework was initialized with the remote registry, the following command will fetch a runtime folder for the hello_world agent from the remote registry:

autonomy fetch valory/hello_world:0.1.0:bafybeiakoj6jpj5gqyjk5qz2ibgvplgd4azqwxmi56aei7xpu5z47np3e4

On the other hand, if you want to fetch the copy stored in your local registry, then you can use:

autonomy --registry-path=./packages fetch valory/hello_world:0.1.0 --local

The Dev template

For convenience, we provide a Dev template repository that you can fork and clone for your Open Autonomy projects, and use it as your workspace folder:

https://github.com/valory-xyz/dev-template

The Dev template comes with:

a preconfigured Pipenv environment with required dependencies,
an empty local registry,
a number of preconfigured linters via Tox.

Populate the local registry for the guides

If you plan to follow the guides in the next sections, you need to populate the local registry with a number of packages shipped with the framework. To do so, edit the local registry index file (./packages/packages.json) and ensure that it has the following third_party entries:

{
    "dev": {
    },
    "third_party": {
        "service/valory/hello_world/0.1.0": "bafybeicdcrhpekqbwzeam2fi7npnl6qfwejgo73ftwoy4tofwbrsl5ene4",
        "agent/valory/hello_world/0.1.0": "bafybeiakoj6jpj5gqyjk5qz2ibgvplgd4azqwxmi56aei7xpu5z47np3e4",
        "connection/valory/abci/0.1.0": "bafybeialznvvjlgftnqdiqo3flrvsdvz2r7ad4rryhkjdbleydsel2ipoi",
        "connection/valory/http_client/0.23.0": "bafybeifgeqgryx6b3s6eseyzyezygmeitcpt3tkor2eiycozoi6clgdrny",
        "connection/valory/ipfs/0.1.0": "bafybeigfmqvlzbp67fttccpl4hsu3zaztbxv6vd7ikzra2hfppfkalgpji",
        "connection/valory/ledger/0.19.0": "bafybeigdckv3e6bz6kfloz4ucqrsufft6k4jp6bwkbbcvh4fxvgbmzq3dm",
        "contract/valory/service_registry/0.1.0": "bafybeib6eed4u2dqggq7jpnb4lury6ylqzdxp6oxxvgrouhcvtmwsbsjbq",
        "protocol/open_aea/signing/1.0.0": "bafybeie7xyems76v5b4wc2lmaidcujizpxfzjnnwdeokmhje53g7ym25ii",
        "protocol/valory/abci/0.1.0": "bafybeihmzlmmb4pdo3zkhg6ehuyaa4lhw7bfpclln2o2z7v3o6fcep26iu",
        "protocol/valory/acn/1.1.0": "bafybeic2pxzfc3voxl2ejhcqyf2ehm4wm5gxvgx7bliloiqi2uppmq6weu",
        "protocol/valory/contract_api/1.0.0": "bafybeialhbjvwiwcnqq3ysxcyemobcbie7xza66gaofcvla5njezkvhcka",
        "protocol/valory/http/1.0.0": "bafybeiejoqgv7finfxo3rcvvovrlj5ccrbgxodjq43uo26ylpowsa3llfe",
        "protocol/valory/ipfs/0.1.0": "bafybeiedxeismnx3k5ty4mvvhlqideixlhqmi5mtcki4lxqfa7uqh7p33u",
        "protocol/valory/ledger_api/1.0.0": "bafybeige5agrztgzfevyglf7mb4o7pzfttmq4f6zi765y4g2zvftbyowru",
        "protocol/valory/tendermint/0.1.0": "bafybeig6g6twajlwssfbfp5rlnu5mwzuu5kgak5cs4fich7rlkx6whesnu",
        "skill/valory/abstract_abci/0.1.0": "bafybeieynwkrnlm6wwtufh2jsgnlprjbpmte7now5rk7fbgd5mh5yumhry",
        "skill/valory/abstract_round_abci/0.1.0": "bafybeifcq2nwd6m5tgxooe7436bc6lwo73xcreedmhcwauzhp5jic6jeq4",
        "skill/valory/hello_world_abci/0.1.0": "bafybeibu3fdkjmawysvbwcn77pzpfw2d4the4ok7jod3jmdiqn4rzms37e",
        "connection/valory/p2p_libp2p_client/0.1.0": "bafybeihge56dn3xep2dzomu7rtvbgo4uc2qqh7ljl3fubqdi2lq44gs5lq"
    }
}

Execute the following command after updating the packages.json file:

autonomy packages sync

The framework will fetch components from the remote registry into the local registry.