golemfoundation / wildland-model

An early model/prototype for Wildland infrastructure

  o       o   o    o o             o
  |       | o |    | |             |
  o   o   o   |  o-O |  oo o-o   o-O
   \ / \ /  | | |  | | | | |  | |  |
    o   o   | o  o-o o o-o-o  o  o-o

Wildland model

This is an early model of a Wildland infrastructure. The main purpose is to allow us to find potential logical loops in the proposed architecture.

This is not intended as a basis for the actual code of a future client software of Wildland.

Coding Conventions

Naming syntax should allow for understanding of the purpose of an object even to humans not familiar with Python language.

Variables and function arguments

• g_{type}_ - all global vars and funcs, plus a type-specifc prefix as below

• wlm_ - WildlandManifest or derived class variables

• wlm_actor_ - WildlandActorManifest or derived class variables

• wlm_storage_ - WildlandStorageManifest or derived class variables

• wlm_compute_ - WildlandComputeManifest or derived class variables

• bknd_storage_ - BackendStorage or derived class variables

• bknd_compute_ - BackendCompute or derived class variables

• drv_storage - DriverStorage or derived class variables

• drv_compute - DriverCompute or derived class variables

Functions and methods

• {Class}.{verb}_{object}_() - e.g. WildlandManifest.add_storage_manifest()
• `wl_{verb}_{object}() - for global functions, the subject here is assumed to be "Wildland (i.e. The WL infrastructure)"