enexa-utils is a set of utilities that provide a simple way to retrieve parameters and store results for ENEXA modules.
All utilities expect to be running in the context of ENEXA module and rely on ENEXA environment variables.
Setup
In the Dockerfile of your module include the following:
COPY --from=enexa-utils:1 / /.
Utilities
enexa-parameter
Retrieve the value of the specified module parameter for the current module execution.
Usage:
./main.py --seed="$(enexa-parameter "http://example.org/parameter/seed")"
enexa-add-file
Store the specified existing file in ENEXA storage and create the corresponding experiment metadata.
If the file is already located in ENEXA_SHARED_DIRECTORY or its subdirectories (typically in ENEXA_MODULE_INSTANCE_DIRECTORY), it will be used directly without creating an additional copy.
An optional second argument makes the file to be the specified module result of the current module execution.
Usage:
enexa-add-file output.csv "http://example.org/result/output"enexa-add-file experiment.log