sciler

Client library for S.C.I.L.E.R.


License
GPL-3.0
Install
pip install sciler==0.2.3

Documentation

BEP_1920_Q2

 ________  ________  ___  ___       _______   ________     
|\   ____\|\   ____\|\  \|\  \     |\  ___ \ |\   __  \    
\ \  \___|\ \  \___|\ \  \ \  \    \ \   __/|\ \  \|\  \   
 \ \_____  \ \  \    \ \  \ \  \    \ \  \_|/_\ \   _  _\  
  \|____|\  \ \  \____\ \  \ \  \____\ \  \_|\ \ \  \\  \| 
    ____\_\  \ \_______\ \__\ \_______\ \_______\ \__\\ _\ 
   |\_________\|_______|\|__|\|_______|\|_______|\|__|\|__|
   \|_________|                                            

Build Status BCH compliance License: GPL v3

The Front-end is developed in Angular with TypeScript, all source code can be found in front-end/.

The Back-end is developed in Go, all source code can be found in back-end/.

The Client Computer Library is initially developed in Python and later a JavaScript version was added, all source code can be found in cc-library/.

All of these parts of SCILER communicate via a MQTT Broker, for which a Mosquitto broker was used.

Each package has its own readme for further information specific to that package.

screenshot of the front-end of SCILER

Structure

SCILER
β”‚   README.md
β”‚
└─── back-end  
β”‚   β”‚   README.md
β”‚   β”‚   
β”‚   └───resources
β”‚   β”‚   └───manuals
β”‚   β”‚   └───production
β”‚   β”‚   └───testing
β”‚   β”‚   
β”‚   └───src
β”‚       └───sciler
β”‚           β”‚   README.md
β”‚           β”‚
β”‚           └───communication
β”‚           β”‚   
β”‚           └───handler
β”‚           β”‚   
β”‚           └───config
β”‚
└─── front-end
β”‚   β”‚   README.md
β”‚   β”‚
β”‚   └─── src
β”‚
└─── cc_library
β”‚   β”‚   README.md
β”‚   β”‚
β”‚   └───py_scc
β”‚   β”‚   β”‚   README.md
β”‚   β”‚   └───sciler
β”‚   β”‚   
β”‚   └───js_scc
β”‚   β”‚   β”‚   README.md
β”‚   β”‚   
β”‚   └───example_scripts_py_scc
β”‚   └───example_scripts_js_scc
β”‚
└─── broker
   β”‚   README.md

License

The license can be found in LICENSE.md in the root of this project.