BUILD.rst

IMOSPATools

Build and installation from this github repository

The IMOS passive audio tools library is wrapped in a python package named IMOSPATools.

1. Install/upgrade pip, build and local install

   python3 -m pip install --upgrade pip
   python3 -m pip install --upgrade build
   

2. Build and install the package locally

   # test build & local install
   # The "-e" install does not seem to be reliable for re-install on Linux
   #       - keeps pulling some old build from somewhere middlewhere.
   #         python -m pip install -e .*
   # This is more reliable:
   python3 -m build
   python3 -m pip install .
   

   Note: when working on the code, in case of doubts that recent changes got propagated, uninstall & purge the installed module _before_ pip install to ensure the installed version has all the recent modifications.

   python3 -m pip -v uninstall IMOSPATools
   python3 -m pip -v cache purge
   

   Optional: Makefile

   There is also a simple Makefile that is capable of the generic make functionality:

   make
   make install
   make clean
   

3. Usage

   To use the functions from the package, just import the module and call the functions:

   from IMOSPATools import ...
   

   (See dat2wav.py.)