settings

package

v1.11.2 Latest Latest Go to latest Published: Apr 21, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/empiricaly/empirica

Links

Open Source Insights

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 ¶

View Source

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

	TreatmentsYAML = "treatments.yaml"

	LobbiesYAML = "lobbies.yaml"

	EmpiricaTOML = "empirica.toml"
)

Variables ¶

View Source

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

Functions ¶

func CacheHomeDir ¶ added in v1.4.3

func CacheHomeDir() string

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

func Check ¶

func Check(name, dir string) error

func ConfigHomeDir ¶ added in v1.4.3

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

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL