- To install the Pioreactor codebase locally, it should be enough to clone the repo pioreactor/pioreactor.
git clone https://github.com/Pioreactor/pioreactor.git && cd pioreactor
- Install the core software are necessary packages (useful to do this in a virtualenv!):
pip3 install -e .
pip3 install -r requirements/requirements_dev.txt
- In the pioreactor folder, create a folder called
You will need to install MQTT and have a broker running locally. On OSX, homebrew can be used to install the MQTT broker
mosquitto. On Windows, it can be installed from this download page.
enable logging in
/usr/local/etc/mosquitto/mosquitto.conf by adding a line like:
log_dest file path/to/somewhere/.mosquitto/log
The CLI tools
mosquitto_sub should work as well.
Running jobs locally
TESTING=1 pio run <job name>
You can also modify to hostname and experiment with
EXPERIMENT=<up to you> \
pio run <job name>
If invoking from a different directory from
pioreactor/, you'll need to have a
config.dev.ini file locally. I usually copy my
pioreactor/config.dev.ini to wherever I am working.
Raspberry Pi Images
Raspberry Pi images are built in the Pioreactor/CustoPizer repo, though these aren't needed for development.