Skip to content

HighTemplar-wjiang/UbiNIRS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UbiNIRS

A tool kit to quick-start NIRS applications without coding.

Architecture

Definitions

  • UbiNIRS App: An Django app running on the server, which performs a specific task using NIRS, such as identifying pills using NIRS.

Dependencies (server)

pip install django django-extensions django-nested-admin django-cleanup numpy joblib scipy scikit-learn===0.22.1 matplotlib pandas

or

cd UbiNIRS
pip install -r requirements.txt

Note: Only tested in Linux, requiring some tweaks for Windows / MacOS.

Quick start

Server side

Start server

cd src/django_server/nirs_server
python manage.py runserver 0.0.0.0:18000
  • In your web browser, visit the URL: server_ip_address:18000/admin/
  • The default username is admin, password is ubinirsadmin

Create new NIRS apps

To create new NIRS apps, simply go to the dashboard, then click "ADD UBI NIRS APP".

Android app side

  • Compile and install the app through Android Studio, or use the pre-compiled apk file.
  • Click the add button on the bottom-right corner.
  • Input the URL shown in the server side with NIRS-app name. By default, the URL for the app is the lower-cased and no-white-space app name (e.g., server_ip_port/smartpillbox for the "Smart Pillbox" app).

To be implemented

Security

  • Currently the secret key is hardcoded in the source file, please use system environment for practical use [reference].

  • There is no authentication for NIRS app access. Considering adding authentication tokens (such as via user log-in) with https protocal.

Deployment

  • For long-term running, please consider a WSGI or an ASGI server [reference].

Related resources

About

A tool kit to quick-start NIRS applications without coding.

Resources

License

Stars

Watchers

Forks

Packages

No packages published