enumeray analysis init
Initialize a private directory with the current publication or an exact author candidate and editable scientific inputs.
Use when: You have a named example or supplied input JSON and want to prepare one intended execution.
Role and prerequisites: Authenticated model user with access to the resource. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.
Example
Section titled “Example”enumeray analysis init csv-example --directory analysis --example starter-example --file dataset=dataset.csvExample names and file/collection slots depend on the selected publication. Inspect model get, or model publication MODEL CANDIDATE_ID for a trial. Candidate initialization saves and displays the exact installation, destination/disclosure, captured grant and any named delegation for explicit review before submit. Local input bytes must remain unchanged until submission reconciliation begins. No credentials or temporary storage URLs are saved in the analysis. See candidate trials.
Inputs and options
Section titled “Inputs and options”| Input | Meaning and use |
|---|---|
<MODEL> |
Accessible model ID from model list/get or the candidate grant holder. |
--candidate <PUBLICATION> |
Exact ready or published retained publication to trial, including before first activation. Requires current model administration/execution access, its captured grant or an exact named delegation, models:manage and runs:create. Saves candidate_trial purpose and this delegation; never substitutes the current publication or activates it. |
--directory <DIRECTORY> |
New private analysis directory. Its parent must exist; existing files, directories and symlinks are preserved. |
--example <EXAMPLE> |
Exact name of a scientific example in the selected current publication or candidate; mutually exclusive with --inputs. |
--inputs <INPUTS> |
Existing scientific input JSON to copy into editable inputs.json; mutually exclusive with --example. |
--file <SLOT=PATH> |
Repeatable SLOT=PATH binding for a declared file input. Replaces that slot’s input reference when constructing effective inputs. Original local files are uploaded for remote execution and remain outside the directory. |
--collection <SLOT=PATH> |
Bind a declared collection slot to a source directory: SLOT=PATH. Select a uniform type with --media-type SLOT=TYPE unless the declaration permits only one. |
--collection-manifest <SLOT=PATH> |
Bind a declared collection slot to an explicit member manifest: SLOT=PATH. Member paths are relative to the manifest’s parent. |
--media-type <SLOT=TYPE> |
Repeatable SLOT=TYPE for a local binding. Omit only when the slot permits exactly one media type. |
--metadata <SLOT=PATH> |
Repeatable SLOT=PATH to a scientific upload-metadata JSON object; defaults to {}. |
Every command also accepts the profile, API, JSON and timeout options.
Result and next step
Section titled “Result and next step”Saves inputs.json, the exact publication/contract/disclosure, source paths/checksums and durable operation identities. Performs no upload or execution. Existing destinations are refused.
Edit inputs.json as needed, review the destination and local bindings, then explicitly authorize execution with analysis submit analysis.
Exact syntax, defaults and accepted values
Save a current publication or exact candidate and inputs for review. Does not upload or execute
Usage: enumeray analysis init [OPTIONS] --directory <DIRECTORY> <MODEL>
Arguments: <MODEL> Stable model ID from model list/get or supplied by its author
Options: --api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration --candidate <PUBLICATION> Trial this exact ready or published candidate using its captured compute authority --directory <DIRECTORY> New private analysis directory; parent must exist and existing paths are refused --profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default] --config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json --example <EXAMPLE> Named input example declared by the selected publication; use either --example or --inputs --inputs <INPUTS> Scientific input JSON object file; use either --inputs or --example. Local slot bindings override references --json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol --file <SLOT=PATH> Bind a declared file slot to an original local source: SLOT=PATH. Repeat for multiple slots --timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60] --collection <SLOT=PATH> Bind a collection slot to a local source directory: SLOT=PATH. Repeat for multiple slots --collection-manifest <SLOT=PATH> Bind a collection slot to a member manifest: SLOT=PATH. Repeat for multiple slots --media-type <SLOT=TYPE> Select a declared media type: SLOT=TYPE. Repeat per slot; inferred only for a sole allowed type --metadata <SLOT=PATH> Scientific upload metadata JSON object file: SLOT=PATH. Repeat per slot; defaults to {} -h, --help Print helpDocumentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.