tlinnet/voxtools

VoxTools

voxtools

How to run the GUI

python -m voxtools.gui.excel

How to install?

Developer install for local conda environment:

# Create environment
conda env create -f environment.yml

# Activate environment
conda env list
source activate voxtools

Or manual install in root environment:

# Manually install package
python setup.py install --force

#  Manually uninstall
python setup.py install --record files.txt
PACK=`dirname $(head -n 1 files.txt)`
rm -rf $PACK
#cat files.txt | xargs rm -rf

Developer

Set PYTHONPATH for local development

# In bash, go to developer directory.
export PYTHONPATH=$PWD

# Try python from another directory
cd $HOME
python -c "import sys;print(sys.path)"
python -c "import voxtools;print(voxtools.__file__)"

# Try with module, and run the GUI
# It needs to have: if __name__ == '__main__':
python -m voxtools.gui.excel

For conda environments

https://conda.io/docs/user-guide/tasks/manage-environments.html#saving-environment-variables

# In bash, go to developer directory.
# Make new directories
mkdir -p $HOME/anaconda/envs/voxtools/etc/conda/activate.d
mkdir -p $HOME/anaconda/envs/voxtools/etc/conda/deactivate.d

# For activate
echo '#!/bin/bash' > $HOME/anaconda/envs/voxtools/etc/conda/activate.d/env_vars.sh
echo "export PYTHONPATH='$PWD'" >> $HOME/anaconda/envs/voxtools/etc/conda/activate.d/env_vars.sh
cat $HOME/anaconda/envs/voxtools/etc/conda/activate.d/env_vars.sh

# For deactivate
echo '#!/bin/bash' > $HOME/anaconda/envs/voxtools/etc/conda/deactivate.d/env_vars.sh
echo "unset PYTHONPATH" >> $HOME/anaconda/envs/voxtools/etc/conda/deactivate.d/env_vars.sh
cat $HOME/anaconda/envs/voxtools/etc/conda/deactivate.d/env_vars.sh

# Then start an new terminal, and test
source activate voxtools
python -c "import sys;print(sys.path)"
python -m voxtools.gui.excel

Run test_suite

Run single tests

# Get options
python -m voxtools.test_suite.excel_test -h

# Run 1 file with test
python -m voxtools.test_suite.excel_test -b
python -m voxtools.test_suite.excel_test -b -v

# Run 1 class from 1 file
python -m voxtools.test_suite.excel_test Test_excel -b -v
# Run 1 test, from 1 class, from 1 file
python -m voxtools.test_suite.excel_test Test_excel.test_copy_excel -b -v

# Another example
python -m voxtools.test_suite.wb04_test Test_wb04.test_make_uniq_key

# With textblob, Run 1 file with test
python -m voxtools.test_suite.textblob_test
python -m voxtools.test_suite.kodning01_test

# With textblob, Run 1 test, from 1 class, from 1 file
python -m voxtools.test_suite.textblob_test Test_excel.test_copy_excel

# With sklearn, Run 1 file with test
python -m voxtools.test_suite.sklearn_test
python -m voxtools.test_suite.multikodning01_test

# With ascii
python -m voxtools.test_suite.ascii_def_test

Run all tests

# From developer directory
python -m unittest discover voxtools.test_suite -p "*_test.py" -b -v