Commit 0db29038 authored by Xuhui Liu's avatar Xuhui Liu
Browse files

1. update Readme

2. update docs
parent 5ceb2f7d
## 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.
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](https://docs.meridian.cs.dal.ca/kedgi/)
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 can easily follow.
## Installation
......@@ -51,4 +51,4 @@ Please note: We also provide a toy detector ([here](toy_detectors/toy_detector_1
## For Developers
Please consult [here]() for developing your own detector script.
\ No newline at end of file
Please consult [here](https://docs.meridian.cs.dal.ca/kedgi/developers.html) for developing your own detector script.
\ No newline at end of file
#!/usr/bin/env bash
\ No newline at end of file
#!/usr/bin
source ~/anaconda3/etc/profile.d/conda.sh
conda activate kedgi_env
#kedgi source folder
if [ ! -d $HOME/kedgi ]; then
echo 'Enter path to kedgi folder, e.g., /home/user/'
read path
KEDGIDIR="$path/kedgi"
else
KEDGIDIR="$HOME/kedgi"
fi
# update sphinx, install sphinx theme, build the docs
python3 -m pip install --upgrade sphinx sphinx_rtd_theme $KEDGIDIR/docs/sphinx_mer_rtd_theme-0.4.3.dev0.tar.gz
make -C $KEDGIDIR/docs html
# copy the html content to the docs server
ssh kedgi_docs << EOF
sudo rm -rf /var/www/html/kedgi
sudo mkdir /var/www/html/kedgi
sudo chown -h -R ubuntu:ubuntu /var/www/html/kedgi
EOF
scp -r $KEDGIDIR/docs/build/html/* kedgi_docs:/var/www/html/kedgi
ssh kedgi_docs << EOF
sudo chown -h -R www-data:www-data /var/www/html/kedgi
sudo chmod -R g+w /var/www/html/kedgi
EOF
......@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Kedgi-mimi's documentation!
Welcome to Kedgi's documentation!
=============================================
.. include:: introduction.rst
......@@ -13,7 +13,7 @@ Welcome to Kedgi-mimi's documentation!
:glob:
:hidden:
Introduction
Introduction <introduction>
Installation <installation>
Tutorials <tutorials>
Versions <versions/index>
......
Introduction
============
**Kedgi** provides a user-friendly graphical interface enabling users to run `MERIDIAN <http://meridian.cs.dal.ca/>`_ acoustic detection and classification software locally on their own machines. **Kedgi** works on both Unix and Windows and no use of Command Line tools or Terminal is needed.
\ No newline at end of file
**Kedgi** provides a user-friendly graphical interface enabling users to run `MERIDIAN <http://meridian.cs.dal.ca/>`_ acoustic detection and classification software locally on their own machines. **Kedgi** works on both Unix and Windows and no use of Command Line tools or Terminal is needed.
**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.
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 can easily follow.
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