Commit 1284202d authored by Xuhui Liu's avatar Xuhui Liu
Browse files

setting current commit as first commit to reduce repo size

parents
venv/
*.pyc
__pycache__/
instance/
docs/build
.pytest_cache/
.coverage
htmlcov/
dist/
*.egg-info/
ketos_env/
git
predictions_percentage.txt
procedures.txt
progress.txt
.idea/
workspace.xml
\ No newline at end of file
This diff is collapsed.
## Welcome to Kedgi, a platform-independent graphical interface for acoustic detectors
Kedgi was developed to facilitate the use of acoustic detectors and classifiers on users' local machines (Windows, Unix and MacOS) without the interaction with Terminal or Common Line Interface (CLI).
Kedgi is written in Python, and utilizes a handful of power software packages including [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Ketos](https://docs.meridian.cs.dal.ca/ketos/), [Numpy](https://numpy.org/) and others. It is licensed under the [GNU GPLv3 license](https://www.gnu.org/licenses/) and hence freely available for anyone to use, modify and distribute. The project is hosted on GitLab at [https://gitlab.meridian.cs.dal.ca/public_projects/kedgi](https://gitlab.meridian.cs.dal.ca/public_projects/kedgi). Kedgi was developed by the [MERIDIAN](http://meridian.cs.dal.ca/) Data Analyst Team at [Institute for Big Data Analytics](https://bigdata.cs.dal.ca/) at Dalhousie University. More information is available in [Kedgi's Documentation Page]()
The intended users of Kedgi are researchers and students in underwater acoustics who have limited knowledge working with CLI. The application is developed with step-by-step workflow so that users are easy to follow.
## Installation
Kedgi is most easily installed and manageable using the Anaconda package manager. The installation package can be found via https://www.anaconda.com/distribution/, choose the python 3.7 version. Anacondas provide several distributions for major Operation Systems, and give very detailed step-by-step instructions on how to set it up. However, when installing tha Anaconda, the installer would prompt that it is not recommended to check the `Add Anaconda3 to my Path Varaible`. But for sake of the simplicity for using Windows Bash scripts, we require you to check `Add Anaconda3 to my Path Variable`. If you failed to do so, please go to [here]() for further details.
After following the installer's instructions, you would have the Anaconda3 in place. In order to run the app, please follow the instructions below
1. Clone the project or download the zipped project files [downloadable from here]()
```bash
git clone https://gitlab.meridian.cs.dal.ca/data_analytics_dal/projects/kedgi.git
cd kedgi
```
2. Create and activate an Anaconda environment.
2.1 Window users
1. In File Explorer, locate the Kedgi project folder you just downloaded (or created) and go inside the Kedgi folder and then double-clicked on ``environment_setup_win.bat``. The successful message is shown as below:
![env_succ](docs/source/_static/success_environment_setup.png)
2. In same File Explorer window, double click the ``activate_win.bat`` and it will activate the app.
![app_succ](docs/source/_static/success_app_activation.png)
2.2 Unix/MacOS users
```bash
sh set_up_script.sh
sh run_app.sh
```
## Use app
Now you will be seeing a list of printed statements showing the web app has started responding. You can access the app at `http://127.0.0.1:5000`.
The application has five stages:
1. Input (Choosing dataset and detector/classifier path)
2. Output (Choosing output directory)
3. Settings (Scripts related configurations)
3. Processing (progressing information)
4. Complete
- Load detection/classification results
- View spectrogram of interest
- Download the spectrogram of interest
Please note: We also provide a toy detector ([here](toy_detectors/toy_detector_1.zip)) for users to experiment and also a sample audio file available under toy_detector/dataset.
## For Developers
Please consult [here]() for developing your own detector script.
\ No newline at end of file
# -*- mode: python ; coding: utf-8 -*-
block_cipher = None
a = Analysis(['activate.py'],
pathex=['C:\\Users\\Xuhui\\PycharmProjects\\acoustic_detector_interface'],
binaries=[],
datas=[],
hiddenimports=[],
hookspath=[],
runtime_hooks=[],
excludes=[],
win_no_prefer_redirects=False,
win_private_assemblies=False,
cipher=block_cipher,
noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
cipher=block_cipher)
exe = EXE(pyz,
a.scripts,
[],
exclude_binaries=True,
name='activate',
debug=False,
bootloader_ignore_signals=False,
strip=False,
upx=True,
console=True )
coll = COLLECT(exe,
a.binaries,
a.zipfiles,
a.datas,
strip=False,
upx=True,
upx_exclude=[],
name='activate')
call "C:\User\%USERNAME%\anaconda3\condabin\conda.bat" activate kedgi_env
set FLASK_ENV=development
set FLASK_APP=flaskr
flask run
cmd /k
\ No newline at end of file
{
"filename": {
"title": "Filename",
"field": "filename",
"sorter": "string",
"align": "center"
},
"start": {
"title": "Start",
"field": "start",
"sorter": "number"
},
"duration": {
"title": "Duration",
"field": "duration",
"sorter": "number"
},
"score": {
"title": "Score",
"field": "score",
"sprter": "number"
}
}
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
div#notebook{
overflow: scroll !important;
}
div#notebook p{
text-align: justify;
font-family: 'Old Standard TT', serif;
}
/* Code snippets */
div.highlight{
background-color: #3892a87a;
}
/* ketos logo */
img#ketos-logo{
border-radius: 0%;
background-color: white;
height: 60%;
width: 60%;
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment