Changeset efb5900 in ammosreader for org/README.md

Timestamp:

05/19/23 12:53:39 (2 years ago)

Author:

Enrico Schwass <ennoausberlin@…>

Branches:

AmmosSource, guix

Children:

6914dbb

Parents:

b00fbbb

Message:

README.md updated

File:

• org/README.md (modified) (1 diff)

org/README.md

@@ -1 @@
-
-# Table of Contents
-
-1.  [AmmosReader](#org2244bce)
-2.  [Installation](#orge8b118b)
-3.  [Usage](#orgcea0ee3)
-    1.  [audio\_reader.py](#orgae8ea86)
-    2.  [iqdw\_reader.py](#orge3ddc95)
-    3.  [pdw\_reader.py](#org59847de)
-
-
-
-<a id="org2244bce"></a>
-
 # AmmosReader
 
-Project containing necessary File- or SocketStream-Reader to read the various datastreams of Ammos
-
-
-<a id="orge8b118b"></a>
+Project containing necessary File- or SocketStream-Reader to read the
+various datastreams of Ammos
 
 # Installation
 
-    git clone http://gitlab.kid.local/kidzg/ammosreader.git
-    cd ammosreader
-    python3 -m pip install .
+## Standard pip install (not tested on all platforms)
 
+``` shell
+git clone http://gitlab.kid.local/kidzg/ammosreader.git
+cd ammosreader
+python3 -m pip install .
+```
 
-<a id="orgcea0ee3"></a>
+## Using the guix functional package manager
+
+First subscribe to the GUIX oai channel (see Chapter Add channel to
+system) in
+<https://gitlab.kid.local/kidzg/guix-deployment/-/blob/master/DevOps.org>)
+
+Then install using the guix
+
+``` shell
+guix package -i python-ammosreader
+```
 
 # Usage
 
-The sample\_scripts subdirectory contains multiple scripts.
+There are two scripts, which demonstrate the usage of the ammosreader
+package.
 
+## iqdw_reader.py
 
-<a id="orgae8ea86"></a>
+``` shell
+python3 iqdw_reader.py 'path_to_iqdw_file'
+```
 
-## audio\_reader.py
+## pdw_reader.py
 
-    python3 audio_reader.py 'path_to_ammos_file'
+``` shell
+python3 pdw_reader.py 'path_to_pdw_file'
+```
 
+To minimize depencencies of the core package other scripts
+(audio_reader, ammos_viewer) are now stored in separate packages.
 
-<a id="orge3ddc95"></a>
+# Logging
 
-## iqdw\_reader.py
+If you use ammosreader in your own scripts a logger can be imported and
+used as follows:
 
-    python3 iqdw_reader.py 'path_to_iqdw_file'
+``` python
+from ammosreader import logger
+logger.warning("Put your warning here")
+```
 
-
-<a id="org59847de"></a>
-
-## pdw\_reader.py
-
-    python3 pdw_reader.py 'path_to_pdw_file'
-
+The name of the logfile is ammos.log The logger uses the directory
+stored in the AMMOS_LOG_DIR environment variable. If this variable is
+not set, /tmp is used as default. If the logfile is not writable, the
+standard logger config is used and the logs go directly to console
+(tty). (see ammos_logging.conf file in this repository)