Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
interkosmos committed Apr 24, 2017
1 parent 6745977 commit 3f742f8
Showing 1 changed file with 12 additions and 20 deletions.
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,35 @@
![OpenADMS](https://www.dabamos.de/github/openadms.png)

OpenADMS is an open source automatic deformation monitoring system for
geodetical and geotechnical measurements. The software is written in Python 3
geodetical and geotechnical observations. The software is written in Python 3
and should run on Python 3.5 upwards. So far, it has been tested with CPython on
FreeBSD 10 (x86-64), NetBSD 7 (ARMv7), and Windows 7 (x86). For more
information, please see https://www.dabamos.de/.
FreeBSD 10 (x86-64, ARMv7), NetBSD 7 (ARMv7), and Windows 7 (x86, x86-64). For
more information, please see https://www.dabamos.de/.

The current development version of OpenADMS is 0.4 (code name “Dar es Salaam”).
The current development version of OpenADMS is 0.4 (code name “Dar es Salaam”).

## Installation
To run OpenADMS, clone the branch and execute `openadms.py`:

```
$ git clone https://github.com/dabamos/openadms.git
$ cd openadms
$ pip install -U -r requirements.txt
$ python3 openadms.py --config ./config/myconfig.json --debug
```

### Libraries
Some additional modules have to be installed in order to use OpenADMS:
Some additional modules are used by OpenADMS:

* [coloredlogs](https://pypi.python.org/pypi/coloredlogs) (MIT Licence)
* [paho-mqtt](https://pypi.python.org/pypi/paho-mqtt) (Eclipse Public Licence)
* [pyserial](https://pypi.python.org/pypi/pyserial) (Python Software Foundation Licence)

The installation can be done with `pip`:

```
$ pip install -U -r requirements.txt
```
## Message Broker
The MQTT protocol is used for the internal message exchange in OpenADMS. An MQTT
message broker, like [Eclipse Mosquitto](https://mosquitto.org/), must be
installed and running before starting OpenADMS. On Unix-like operating systems
an installed Mosquitto MQTT message broker can be launched with:

```
# service mosquitto onestart
```
The MQTT protocol is used for the internal and external message exchange in
OpenADMS. An MQTT message broker, like [Eclipse Mosquitto](https://mosquitto.org/)
or [HBMQTT](https://github.com/beerfactory/hbmqtt), must be installed and
running before starting OpenADMS.

For testing only, the public sandbox broker of
[Eclipse IoT](https://iot.eclipse.org/getting-started) can be used. The server
Expand All @@ -56,8 +48,8 @@ $ python3 openadms.py --config ./config/myconfig.json --debug
```

## Virtual Environment
For the set-up of an independent Python environment the tool `pyvenv` can be
used, which is part of Python 3:
The Python tool `pyvenv` can be used to set-up a virtual environment for
development:

```
$ pyvenv-3.5 ~/virtual-environment
Expand Down

0 comments on commit 3f742f8

Please sign in to comment.