- Foreword
- Synopsis
- Latest Version
- Installation
- Documentation
- Bug Reporting
- Contributors
- Contacts
- License
- Copyright
As OBNL uses AMQP/MQTT protocol (with pika), a server SHALL be running. If docker is installed the following command starts a RabbitMQ server:
docker run -d --hostname my-rabbit -p 5672:5672 --name some-rabbit rabbitmq:alpine
OBNL was initially imagined as a light implementation of OpenBuildNet (OBN) in Python. Its name initially means OpenBuildNet Light.
The main purpose of OBNL is simulator communication for the purpose of co-simulation.
During the first development and tests, we realised that it was very complicated to match the requirement of OBN. Therefore we decided to realise a co-simulator based on OBN - an "OpenBuildNet Like" co-simulator.
You can find the latest version of OBNL of : https://github.com/ppuertocrem/obnl
OBNL is a full python project thus as long as Python is installed on your system you can install it by moving in the root folder (the folder this README file should be) and run :
python setup.py install
In some systems you need Administrator rights to run this command.
Warning : OBNL requires these packages to be used in full :
- pika
- protobuf
Currently, the documentation is only accessible in source code.
If you find any bugs, or if you want new features you can put your request on github at the following address : https://github.com/ppuertocrem/obnl
The OBNL Team is currently composed of :
- Pablo Puerto ([email protected])
- Gillian Basso ([email protected])
- Jessen Page ([email protected])
For questions, bug reports, patches and new elements / modules, please use the Bug Reporting.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Copyright (C) 2017 The OBNL Team
This file is part of the OBNL project.
OBNL is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
OBNL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.