autory run direct
Usage: [OPTIONS] [PATHS]...
Run one or more Autory models directly.
PATHS: Names or paths of files containing Autory models. These may be JSON
files, YAML files, Excel workbooks, or a mixture of those. With the VBA
engine, only Excel workbooks are supported.
Options:
--excel-visible / --excel-invisible
Override the `ExcelVisible` run control
value for all models. This is deprecated.
Use `--run-control` instead.
--engine [vba|python-excel|pyxl|python-julia|pyjl]
Override the `AutoryEngine` run control
value for all models.
--output-folder DIRECTORY Override the `OutputFolder` run control
option for all models in all runs. If this
is a relative path, it's relative to each
model's base path. The base path of a model
is normally the folder containing the model
file. This is deprecated. Use `--run-
control` instead.
--single-workbook / --separate-workbooks
Override the `OutputSingleWorkbook` run
control value for all models. This is
deprecated. Use `--run-control` instead.
--parallel INTEGER The number of models to run in parallel.
Optimal performance is probably achieved by
setting this to about half the number of CPU
cores. Your mileage may vary.
--vba-engine-dir DIRECTORY The folder containing `autory.xlsm` (the VBA
engine). Instead of detecting the path to
the VBA autory engine automatically, use the
given path. For advanced users and
developers only.
--run-control, --rc TEXT Override one or more run control options for
all models.
--data-table TEXT Add data table(s) to the model(s) before
running them. See detailed help below.
--help Show this message and exit.
--------
Adding or overriding data tables:
`--data-table` may be specified multiple times to add multiple data
tables.
Each data table is specified as a comma-separated list of options, with
the following options available:
- `name`: The name of the data table to add in the model. This is
required.
- `src_file`: The path to the source file containing the data table.
This is required.
- `src_type`: The type of the source file. The supported types are
`feather`, `excel`, `csv`. If omitted, the type is inferred from the
file extension if possible.
- `src_table`: For files that contain multiple data tables (like
Excel workbooks), this specifies the name of the table to load.
- `existing`: What to do if a data table with the same name already
exists in the model.
- `replace`: Replace the existing data table with the new one.
(This is the default.)
- `skip`: Skip adding the new data table if one with the same
name already exists.
- `error`: Raise an error if a data table with the same name
already exists in the model.
The `--data-table` option reuses the logic from one of these functions,
depending on `src_type`:
- `feather`: See https://autory.autoactuary.com/functions/table-
create-load/feather-to-table.html
- `excel`: See https://autory.autoactuary.com/functions/table-
create-load/excel-table.html
- `csv`: See https://autory.autoactuary.com/functions/table-create-
load/csv-to-table.html
Examples:
- Load the contents of a CSV file into a data table called `Table1`:
`--data-table name=Table1,src_file=file.csv`
- Load the contents of `Table2` from an Excel workbook into a data table
called `Table1` in the model:
`--data-table name=Table1,src_file=file.xlsx,src_table=Table2`