Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 3.23 KB

CORE_DEVELOPMENT.md

File metadata and controls

101 lines (65 loc) · 3.23 KB
Raw

This document shows the steps involved in setting up a VOLTTRON development environment.

Requirements

  • git >= 2.25
  • poetry >= 1.2.0b1
  • python >= 3.8

Optional but handy is installing the tree command.

The below commands assume you have the required version of python already installed.

$> sudo apt install git 

# As of this writting the 1.2 version of poetry is in beta and is in the  master branch of poetry.
$> curl -sSL https://install.python-poetry.org | python3 - --preview

# Add poetry path to PATH variable. Also add this to your ~/.bashrc file  
export PATH="/home/volttron/.local/bin:$PATH"

# Configure poetry to use project root virtual environments
$> poetry config virtualenvs.in-project true

# Check the configuration
$> poetry config --list

Environment Setup

For the rest of the document we assume /repos/volttron-core is the root of the git cloned repository and is designated as the VOLTTRON_ROOT.

Clone the volttron-core repository

$> cd /repos
$> git clone https://github.com/VOLTTRON/volttron-core.git --branch develop
$> cd volttron-core

Installing volttron

The following will install the volttron into a virtual environment. The environment can be referenced from a development environment such as visual studio code or pycharm.

$> cde /repos/volttron-core
$> poetry install

# creates a new shell and activate the environment
$> poetry shell

After executing the above commands your environment is setup for starting volttron. The next step is to begin developing an agent, or continue on with setting up pycharm for use with this environment.

Note: To exit the poetry shell use the exit command. this deactivates the environment and exits the spawned shell.

Pycharm Setup

  • Open the volttron-core project
  • Reference the python in .venv/bin/python under volttron-core directory. (Only there if you configured in-place above otherwise reference virtual environment for this project)
    • In pycharm go to: Settings -> Python Interpreter -> Virtual Environment(on the left) -> On the right pick existing environment. Give the path to python in your volttron-core's virtual environment.

Pycharm Interpretor Settings

Debugging VOLTTRON in Pycharm

The following are run from the same python environment and are highlighted red where either changes need to be made from the default or are areas that should be verified are correct for the different use cases.

Make sure that your pycharm settings are gevent compatible

Pycharm Gevent Compatible

Create a Run/Debug configuration for volttron and vctl like the following.

NOTE The below two screenshots show the project as "volttron-project". If you skipped the optional steps replace "volttron-project" with "volttron-core"

Pycharm Run volttron -vv

Pycharm Run vctl -vv command

Commiting code changes

  1. Changes should be done to new branch on your own fork, and PR should be created to merge to main branch.

Please see Agent Development for more information on developing agents for volttron.