volttron-lib-web 0.1.1a0

No project description provided

VOLTTRON™ is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data.

Installation with Web

> pip install volttron-lib-web

Quick Start

1. Start the platform

   > volttron -vv -l volttron.log &>/dev/null &
   

2. Install listener agent

   > vctl install volttron-listener
   

3. View status of platform

   > vctl status
   

4. Shutdown the platform

   > vctl shutdown --platform
   

Full VOLTTRON documentation available at VOLTTRON Readthedocs

Contributing to VOLTTRON

Please see the contributing.md document before contributing to this repository.

Development of VOLTTRON

Environment

VOLTTRON uses Poetry, a dependency management and packaging tool for Python. If you don't have Poetry installed on your machine, follow these steps to install it on your machine.

To check if Poetry is installed, run poetry --version. If you receive the error 'command not found: poetry', add the following line to your '~/.bashrc' script: export PATH=$PATH:$HOME/.poetry/bin.

Recommended configuration for poetry

By default, poetry creates a virtual environment in {cache-dir}/virtualenvs. To configure 'poetry' to create the virtualenv inside this project's root directory, run the following command:

poetry config virtualenvs.in-project true

Setup

1. Clone the repository

   git clone https://github.com/VOLTTRON/volttron-core -b develop
   

2. cd into volttron-core directory

   cd volttron-core
   

3. Install volttron into the current directory

   poetry install
   

4. Run tests

   poetry run pytest
   

5. Activate environment (removes the need for add poetry run to all commands)

   poetry shell
   

6. Run volttron

   volttron -vv -l volttron.log &>/dev/null &
   

Using modules to run VOLTTRON

In order to run VOLTTRON from within an ide the recommended way is to run the platform using the modules

> poetry shell
> python -m volttron.server -vv -l volttron.log &
> python -m volttron.commands.control -vv status

Please see the contributing.md document before contributing to this repository.

Happy Editing!