Skip to content

dansterenson/Noesis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codecov Build Status Documentation Status

Noesis

Noesis is project that supports a Brain Computer Interface — imaginary hardware that can read minds, and upload snapshots of cognition. The project includes a client, which streams cognition snapshots to a server, which then publishes them to a message queue, where multiple parsers read the snapshot, parse various parts of it, and publish the parsed results, which are then saved to a database. The results are then exposed via a RESTful API, which is consumed by a CLI; there's also a GUI, which visualizes the results in various ways.

Installation

  1. Clone the repository and enter it:

    $ git clone [email protected]:dansterenson/Noesis.git
    ...
    $ cd Noesis/
  2. Run the installation script and activate the virtual environment:

    $ ./scripts/install.sh
    ...
    $ source .env/bin/activate
    [Noesis] $ # you're good to go!
  3. To check that everything is working as expected, run the tests:

    $ pytest tests/
    ...

Deployment

To run all of the services together for a quick start using Docker:

 $ .scripts/run-pipeline.sh

When all services are running, you can access the GUI at http://localhost:8080

Usage

After installation is completed and all services are running. use the client module to upload user's snapshots to the system (Sample file example can be downloaded from here)

    [Noesis] $ python -m Noesis.client upload-sample 
                      path_to_file
                      -h 0.0.0.0 -p 8000 

After uploading is completed, you can view the results in the GUI:

 [Noesis] $ http://localhost:8080

Or use the CLI to see the results

Documentation

The full documenation is available here.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published