Skip to content

Commit

Permalink
Minor updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
interkosmos committed Feb 20, 2024
1 parent 214089b commit 6806855
Show file tree
Hide file tree
Showing 3 changed files with 779 additions and 670 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Deformation Monitoring Package (DMPACK)

[![Build](https://github.com/dabamos/dmpack/actions/workflows/build.yml/badge.svg)](https://github.com/dabamos/dmpack/actions/workflows/build.yml)

DMPACK is a free and open-source software package for IoT-based automatic
deformation monitoring and distributed control measurements in engineering
geodesy and geotechnics. The project is the successor of
Expand Down Expand Up @@ -239,12 +241,12 @@ Either link your programs against static library `libdmpack.a`, or `-ldmpack` if
`libdmpack.so` is in your library search path, for example:

```
$ gfortran -o example example.f90 /usr/local/lib/libdmpack.a
$ gfortran -I/usr/local/include/dmpack -o example example.f90 /usr/local/lib/libdmpack.a
```

Depending on which parts of the DMPACK library are used by third-party
applications, additional shared libraries have to be linked. You probably have
to pass the directory containing the DMPACK module files with argument `-I`.
applications, additional shared libraries have to be linked. The directory
containing the DMPACK module files is passed through argument `-I`.

| Module | Libraries | Linker Libraries |
|----------------|---------------|-------------------------------------------------------|
Expand Down Expand Up @@ -349,8 +351,16 @@ $ export DM_MQTT_HOST="localhost"
$ export DM_MQTT_PORT="1883"
```

If not set, the affected tests will be skipped. You may want to set the
variables permanently in `runtest.sh`. Run all test programs with:
If not set, the affected tests will be skipped. To skip the pipe, plotting, and
message queue tests, set:

```
$ export DM_MQUEUE_SKIP=1
$ export DM_PIPE_SKIP=1
```

You may want to uncomment the variables in `runtest.sh`. Run all test programs
with:

```
$ sh runtests.sh
Expand Down
22 changes: 15 additions & 7 deletions guide/guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:orgname: DABAMOS
:revnumber: 0.9.3
:lang: en
:docdate: 2023-12-28
:docdate: 2024-02-18
:doctype: book
:url-org: https://dabamos.de/
:url-project: {url-org}dmpack
Expand Down Expand Up @@ -288,8 +288,9 @@ $ sudo apt install --no-install-recommends libblas-dev liblapack-dev \
....

Instead of package `gnuplot`, you can install the no-X11 flavour `gnuplot-nox`
if raster image formats are not needed (SVG output only). Depending on the
package repository, the names of the Lua packages may differ.
if raster image formats are not needed (SVG output only). The SQLite 3 package
version must be ≥ 3.39.0. Depending on the package repository, the names of the
HDF5 and Lua packages may differ.

If Intel oneAPI Fortran will be used to compile DMPACK, you have to build HDF5
from source as well, as the versions in the Linux package repositories have been
Expand All @@ -306,6 +307,13 @@ $ cd dmpack/
$ make linux
....

In case SQLite 3 has been built from source, overwrite the variable `LIBSQLITE3`
to pass the path of shared library `libsqlite3.so`:

....
$ make OS=linux PREFIX=/usr LIBSQLITE3="-L/usr/local/lib -Wl,-rpath,/usr/local/lib -lsqlite3"
....

If the Intel oneAPI compilers are preferred, run instead:

....
Expand All @@ -318,7 +326,7 @@ Install the library and all programs system-wide to `/usr`:
$ sudo make install_linux
....

To install to a custom directory, run:
To install to directory `/opt`, run:

....
$ sudo make install PREFIX=/opt
Expand Down Expand Up @@ -346,9 +354,9 @@ $ sed -i "s/lua-5/lua5/g" build/dependencies/fortran-lua54/fpm.toml

== Deformation Monitoring Entities [[entities]]

The data structures used by DMPACK are based on the following entities. The
date and time format used internally is a 32-characters long ISO 8601 in
microsecond resolution, with time separator `T` and mandatory GMT offset, for
The data structures of DMPACK are based on the following entities. The
internally used date and time format is a 32-characters long ISO 8601 time stamp
in microsecond resolution, with time separator `T` and mandatory GMT offset, for
example, `1970-01-01T00:00:00.000000+00:00`.

=== Observation Entities
Expand Down
Loading

0 comments on commit 6806855

Please sign in to comment.