volttron-lib-base-driver 0.2.1rc2

Volttron Driver libraries used to support development within the Volttron Driver Framework.

volttron-lib-base-driver

Prerequisites

• Python 3.10

Python

To install Python 3.10, we recommend using pyenv.

# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.8
pyenv install 3.10

# make it available globally
pyenv global system 3.10

Installation

Create and activate a virtual environment.

python -m venv env
source env/bin/activate

Install volttron and start the platform.

pip install volttron

# Start platform with output going to volttron.log
volttron -vv -l volttron.log &

Install the library. You have two options. You can install this library using the version on PyPi:

pip install volttron-lib-base-driver

Or you can install the local version of this library from this repo:

pip install -e .

Development

Please see the following for contributing guidelines contributing.

Please see the following helpful guide about developing modular VOLTTRON agents

Disclaimer Notice

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.