Note
This is a reference implementation and experimentation sandbox for the Global Brain algorithm.
To get a dev shell, run direnv allow.
This will copy the contents from .env.example to a .env file, set the environment variables, and fetch the required dependencies.
Make sure to check out the .env.example file to see the required environment variables.
src/
This project is structured as a Julia module, so the code is located in src.
Within src, there are two main components: lib and service.
The lib folder contains the algorithm along with the tooling around it and the service folder contains a service that consumes a vote stream and outputs a top reply score stream.
As the service maintains some state, db.jl contains a SQLite database interface.
Finally, simulations.jl contains a simulation framework with which simple scenarios can be created and run on the Global Brain algorithm.
simulations/
Simulations created with the framework in simulations.jl are located in the simulations folder.
app/
A visualization app with which simulations can be explored and analyzed.
We use the just command runner to automate workflows.
Following are a few of the recipes we provide.
-
run the service:
just run -
reset the service database:
just reset-db -
open a sqlite REPL of the service database:
just db -
run the simulations:
just sim -
open a sqlite REPL of the simulation database:
just sim-db -
run the simulation visualization app:
just app -
run Julia unit tests:
just unit-tests -
run algorithm integration tests:
just test