Eregime Workflow
Direct command workflow for generating eregime.in files.
This module implements CLI workflow orchestration for its command family, including argument parsing, request construction, execution dispatch, and result presentation handoff.
Usage context
- Command routing: Resolve CLI aliases and normalized command names.
- Task execution: Build request objects and invoke registered tasks.
- Output handling: Forward results to table, plot, export, or report flows.
Command: gen_eregime
Arguments
No command-specific arguments found.
Common Runtime and Presentation Arguments
These are shared workflow-level CLI flags added before command-specific options, covering runtime context (engine/input/storage) and output presentation/export behavior.
| Flag | Required | Default | Help | Choices |
|---|---|---|---|---|
--type |
Yes | Generator profile type. Example: --type sin, which selects sinusoidal waveform generation. | sin, pulse, func | |
--output |
No | eregime.in | Output file path. Example: --output eregime_custom.in, which writes the generated file with that name. | |
--copy-to-dot |
No | Also copy generated output to current directory. Example: --copy-to-dot, which keeps a convenience copy where you run the command. | ||
--direction |
No | z | Field direction: x|y|z. Example: --direction x, which applies the field along x-axis. | |
--V |
No | 1 | Voltage index. Example: --V 2, which writes the field under voltage channel/index 2. | |
--start-iter |
No | 0 | Starting iteration. Example: --start-iter 1000, which starts the generated schedule at iteration 1000. | |
--max-magnitude |
No | Peak amplitude for sin profile (V/A). Example: --max-magnitude 0.004, which sets the sine peak field strength. | ||
--step-angle |
No | Angular sampling step for sin profile (radians). Example: --step-angle 0.05, which controls sine sampling density per cycle. | ||
--num-cycles |
No | Number of cycles for sin or pulse profile. Example: --num-cycles 3, which repeats the waveform for three cycles. | ||
--phase |
No | 0.0 | Phase offset for sin profile (radians). Example: --phase 1.57, which shifts the sine wave by roughly pi/2. | |
--dc-offset |
No | 0.0 | DC offset for sin profile (V/A). Example: --dc-offset 0.001, which adds a constant baseline to the sine waveform. | |
--amplitude |
No | Peak amplitude for pulse profile (V/A). Example: --amplitude 0.003, which sets the pulse peak field strength. | ||
--width |
No | Flat-top width for pulse profile. Example: --width 50, which sets how long each pulse stays at peak level. | ||
--period |
No | Full-cycle period for pulse profile. Example: --period 200, which sets one pulse cycle duration. | ||
--slope |
No | Ramp duration for pulse profile. Example: --slope 20, which sets rise/fall transition duration. | ||
--step-size |
No | 0.1 | Temporal resolution for pulse profile. Example: --step-size 0.1, which samples the pulse every 0.1 time unit. | |
--baseline |
No | 0.0 | Baseline for pulse profile (V/A). Example: --baseline 0.0005, which shifts the pulse around a non-zero base field. | |
--expr |
No | Python expression in t for func profile. Example: --expr '0.003cos(2pi*t/100)', which defines field value as a function of t. | ||
--t-end |
No | End time for func profile. Example: --t-end 1000, which sets the final time point for function sampling. | ||
--dt |
No | Time step for func profile. Example: --dt 1, which samples the function every 1 time unit. | ||
--iteration-step |
Yes | Iterations per sample. Example: --iteration-step 250, which maps each generated sample to 250 MD iterations. | ||
--run-id |
No | Run identifier for run-scoped layout (e.g., run_91ac0e). | ||
--project-root |
No | Project root that contains inputs/, data/, analysis/, etc. | ||
--analysis-id |
No | Optional analysis artifact id; defaults to run id. |