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.7 (recommended >= 3.10)
• Pip
• Pipenv >=2021.x.xx
• Docker Engine
• Docker Compose

Set up

1. Create a workspace folder:

   mkdir my_workspace
   cd my_workspace
   

2. Set up the environment. 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
   

3. Install the Open Autonomy framework:

   pip install open-autonomy[all]
   

4. Initialize the framework to work with the remote IPFS registry. This means that when the framework will be fetching a component, it will do so from the IPFS:

   autonomy init --remote --ipfs
   

   Info

   The InterPlanetary File System (IPFS) is a protocol, hypermedia and file sharing peer-to-peer network for storing and sharing data in a global, distributed file system. Open Autonomy can use components stored in the IPFS, or stored locally.