gvdr / inv_anomaly_package Goto Github PK

Development repository for outlier detection of ION


To use, clone the repo. Make a virtual environment as follows: (works unter python 3.10.) 

in the root folder of the repo (INV_...)

python3.10 -m venv "venv_p3.10"
source venv_p3.10/bin/activate
pip install -r requirements.txt
pip install outlierdetection --no-index --find-links outlierdetection/dist/

(For a complete list of required packages (from pip freeze), see requirements.txt)
(If somehow --no-index --find-links can be applied only locally to a single package in requirements.txt, we could also include the last pip install outlierdetection... in the previous step, but I wasn't successful in that. The pip manual states that the -- flags are global unfortunately.)



For a specific version (instead of the latest), change the last step to

pip install outlierdetection==0.1.0 --no-index --find-links outlierdetection/dist/


If new versions have been released and the wheels have been pulled to outlierdetection/dist/, upgrade via 

pip install --upgrade outlierdetection --no-index --find-links outlierdetection/dist/



Alternatively, the package can be installed via
poetry install
in the outlierdetection folder. Then however, there is a link to the outlierdetection/src folder in site-packages instead of a physical copy of the package files. 


The package should be importable now as, e.g., 
import outlierdetection.univariate as UOD
for the main class or simply
import outlierdetection

The currently installed version is accessible via
pip show outlierdetection


automatic tests are available: in folder outlierdetection, run
pytest tests/
pytest tests/ --cov=outlierdetection --cov-report term-missing



To setup sphinx from scratch in root folder:
mkdir docs 
cd docs
sphinx-quickstart 

Then, in source/conf.py, add the lines
import sys
import os
sys.path.insert(0, os.path.abspath('../../outlierdetection/src'))

and add to the extenions list 'sphinx.ext.autodoc', e.g. 
extensions = ['sphinx.ext.autodoc']

Then, in docs/, run 
make html


Comments:
- There is currently a bug (September 11) with sphinx 7.2.5, loading numpy.typing.ufunc. Downgrade to 7.2.4 fixes it.