Changeset efb5900 in ammosreader


Ignore:
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

Files:
2 edited

Legend:

Unmodified
Added
Removed

  • README.md

    rb00fbbb refb5900  
    1 
    2 # Table of Contents
    3 
    4 1.  [AmmosReader](#org2244bce)
    5 2.  [Installation](#orge8b118b)
    6 3.  [Usage](#orgcea0ee3)
    7     1.  [audio\_reader.py](#orgae8ea86)
    8     2.  [iqdw\_reader.py](#orge3ddc95)
    9     3.  [pdw\_reader.py](#org59847de)
    10 
    11 
    12 
    13 <a id="org2244bce"></a>
    14 
    151# AmmosReader
    162
    17 Project containing necessary File- or SocketStream-Reader to read the various datastreams of Ammos
    18 
    19 
    20 <a id="orge8b118b"></a>
     3Project containing necessary File- or SocketStream-Reader to read the
     4various datastreams of Ammos
    215
    226# Installation
    237
    24     git clone http://gitlab.kid.local/kidzg/ammosreader.git
    25     cd ammosreader
    26     python3 -m pip install .
     8## Standard pip install (not tested on all platforms)
    279
     10``` shell
     11git clone http://gitlab.kid.local/kidzg/ammosreader.git
     12cd ammosreader
     13python3 -m pip install .
     14```
    2815
    29 <a id="orgcea0ee3"></a>
     16## Using the guix functional package manager
     17
     18First subscribe to the GUIX oai channel (see Chapter Add channel to
     19system) in
     20<https://gitlab.kid.local/kidzg/guix-deployment/-/blob/master/DevOps.org>)
     21
     22Then install using the guix
     23
     24``` shell
     25guix package -i python-ammosreader
     26```
    3027
    3128# Usage
    3229
    33 The sample\_scripts subdirectory contains multiple scripts.
     30There are two scripts, which demonstrate the usage of the ammosreader
     31package.
    3432
     33## iqdw_reader.py
    3534
    36 <a id="orgae8ea86"></a>
     35``` shell
     36python3 iqdw_reader.py 'path_to_iqdw_file'
     37```
    3738
    38 ## audio\_reader.py
     39## pdw_reader.py
    3940
    40     python3 audio_reader.py 'path_to_ammos_file'
     41``` shell
     42python3 pdw_reader.py 'path_to_pdw_file'
     43```
    4144
     45To minimize depencencies of the core package other scripts
     46(audio_reader, ammos_viewer) are now stored in separate packages.
    4247
    43 <a id="orge3ddc95"></a>
     48# Logging
    4449
    45 ## iqdw\_reader.py
     50If you use ammosreader in your own scripts a logger can be imported and
     51used as follows:
    4652
    47     python3 iqdw_reader.py 'path_to_iqdw_file'
     53``` python
     54from ammosreader import logger
     55logger.warning("Put your warning here")
     56```
    4857
    49 
    50 <a id="org59847de"></a>
    51 
    52 ## pdw\_reader.py
    53 
    54     python3 pdw_reader.py 'path_to_pdw_file'
    55 
     58The name of the logfile is ammos.log The logger uses the directory
     59stored in the AMMOS_LOG_DIR environment variable. If this variable is
     60not set, /tmp is used as default. If the logfile is not writable, the
     61standard logger config is used and the logs go directly to console
     62(tty). (see ammos_logging.conf file in this repository)

  • org/README.md

    rb00fbbb refb5900  
    1 
    2 # Table of Contents
    3 
    4 1.  [AmmosReader](#org2244bce)
    5 2.  [Installation](#orge8b118b)
    6 3.  [Usage](#orgcea0ee3)
    7     1.  [audio\_reader.py](#orgae8ea86)
    8     2.  [iqdw\_reader.py](#orge3ddc95)
    9     3.  [pdw\_reader.py](#org59847de)
    10 
    11 
    12 
    13 <a id="org2244bce"></a>
    14 
    151# AmmosReader
    162
    17 Project containing necessary File- or SocketStream-Reader to read the various datastreams of Ammos
    18 
    19 
    20 <a id="orge8b118b"></a>
     3Project containing necessary File- or SocketStream-Reader to read the
     4various datastreams of Ammos
    215
    226# Installation
    237
    24     git clone http://gitlab.kid.local/kidzg/ammosreader.git
    25     cd ammosreader
    26     python3 -m pip install .
     8## Standard pip install (not tested on all platforms)
    279
     10``` shell
     11git clone http://gitlab.kid.local/kidzg/ammosreader.git
     12cd ammosreader
     13python3 -m pip install .
     14```
    2815
    29 <a id="orgcea0ee3"></a>
     16## Using the guix functional package manager
     17
     18First subscribe to the GUIX oai channel (see Chapter Add channel to
     19system) in
     20<https://gitlab.kid.local/kidzg/guix-deployment/-/blob/master/DevOps.org>)
     21
     22Then install using the guix
     23
     24``` shell
     25guix package -i python-ammosreader
     26```
    3027
    3128# Usage
    3229
    33 The sample\_scripts subdirectory contains multiple scripts.
     30There are two scripts, which demonstrate the usage of the ammosreader
     31package.
    3432
     33## iqdw_reader.py
    3534
    36 <a id="orgae8ea86"></a>
     35``` shell
     36python3 iqdw_reader.py 'path_to_iqdw_file'
     37```
    3738
    38 ## audio\_reader.py
     39## pdw_reader.py
    3940
    40     python3 audio_reader.py 'path_to_ammos_file'
     41``` shell
     42python3 pdw_reader.py 'path_to_pdw_file'
     43```
    4144
     45To minimize depencencies of the core package other scripts
     46(audio_reader, ammos_viewer) are now stored in separate packages.
    4247
    43 <a id="orge3ddc95"></a>
     48# Logging
    4449
    45 ## iqdw\_reader.py
     50If you use ammosreader in your own scripts a logger can be imported and
     51used as follows:
    4652
    47     python3 iqdw_reader.py 'path_to_iqdw_file'
     53``` python
     54from ammosreader import logger
     55logger.warning("Put your warning here")
     56```
    4857
    49 
    50 <a id="org59847de"></a>
    51 
    52 ## pdw\_reader.py
    53 
    54     python3 pdw_reader.py 'path_to_pdw_file'
    55 
     58The name of the logfile is ammos.log The logger uses the directory
     59stored in the AMMOS_LOG_DIR environment variable. If this variable is
     60not set, /tmp is used as default. If the logfile is not writable, the
     61standard logger config is used and the logs go directly to console
     62(tty). (see ammos_logging.conf file in this repository)
Note: See TracChangeset for help on using the changeset viewer.