settings

Documentation

Index

• Constants
• Variables
• func CacheHomeDir() string
• func Check(name, dir string) error
• func ConfigHomeDir() string
• func CreateEmpiricaDir(name, dir string) error
• func Init(name, dir string) error
• func InitShared()
• func InstallVolta(ctx context.Context) error
• func InstallVoltaIfNeeded(ctx context.Context) error
• func ReadIDFile(dir string) (string, error)
• func SharedDataDir() string
• func VoltaBinDir() string
• func VoltaDir() string
• func VoltaIsInstalled() bool

Constants

const (
	EmpiricaDir        = ".empirica"
	BuildSelectionFile = "release"
	LocalDir           = "local"

	TreatmentsYAML = "treatments.yaml"

	LobbiesYAML = "lobbies.yaml"

	EmpiricaTOML = "empirica.toml"
)

Variables

var ErrEmpiricaDirMissing = errors.New("empirica directory missing")

Functions

func CacheHomeDir

func CacheHomeDir() string

CacheHomeDir returns the path where Empirica cache files should be stored.

func Check

func Check(name, dir string) error

func ConfigHomeDir

func ConfigHomeDir() string

ConfigHomeDir returns the path where Empirica config files should be stored.

func CreateEmpiricaDir

func CreateEmpiricaDir(name, dir string) error

func Init

func Init(name, dir string) error

func InitShared

func InitShared()

InitShared initialize shared environment paths.

func InstallVolta

func InstallVolta(ctx context.Context) error

func InstallVoltaIfNeeded

func InstallVoltaIfNeeded(ctx context.Context) error

func ReadIDFile

func ReadIDFile(dir string) (string, error)

func SharedDataDir

func SharedDataDir() string

SharedDataDir returns the path where shared Empirica files should be stored. This is generally used as a cache.

func VoltaBinDir

func VoltaBinDir() string

VoltaBinDir is the directory containing the Volta shim executables.

func VoltaDir

func VoltaDir() string

VoltaDir is the directory for the Volta installation.

func VoltaIsInstalled

func VoltaIsInstalled() bool