aimbat._cli
Modules:
| Name | Description |
|---|---|
align |
Align seismograms using ICCS or MCCC. |
common |
Common parameters and functions for the AIMBAT CLI. |
data |
Manage data sources in an AIMBAT project. |
event |
View and manage events in the AIMBAT project. |
pick |
Interactively pick phase arrival times and processing parameters. |
plot |
Create plots for seismograms and ICCS results. |
project |
Manage AIMBAT projects. |
seismogram |
View and manage seismograms in the AIMBAT project. |
snapshot |
View and manage snapshots of processing parameters. |
station |
View and manage stations. |
utils |
Utilities for AIMBAT. |
align
Align seismograms using ICCS or MCCC.
This command aligns seismograms using either the ICCS or MCCC algorithm. Both
commands update the pick stored in t1. If t1 is None, t0 is used as
starting point instead, with the resulting pick stored in t1.
Functions:
| Name | Description |
|---|---|
cli_iccs_run |
Run the ICCS algorithm to align seismograms for the default event. |
cli_mccc_run |
Run the MCCC algorithm to refine arrival time picks for the default event. |
cli_iccs_run
cli_iccs_run(
*,
autoflip: bool = False,
autoselect: bool = False,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Run the ICCS algorithm to align seismograms for the default event.
Iteratively cross-correlates seismograms against a running stack to refine
arrival time picks (t1). If t1 is not yet set, t0 is used as the
starting point.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
autoflip
|
bool
|
Whether to automatically flip seismograms (multiply data by -1) when the cross-correlation is negative. |
False
|
autoselect
|
bool
|
Whether to automatically de-select seismograms whose
cross-correlation with the stack falls below |
False
|
Source code in src/aimbat/_cli/align.py
cli_mccc_run
cli_mccc_run(
*,
all_seismograms: Annotated[
bool, Parameter(name=all)
] = False,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Run the MCCC algorithm to refine arrival time picks for the default event.
Multi-channel cross-correlation simultaneously determines the optimal time
shifts for all seismograms. Results are stored in t1.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
all_seismograms
|
Annotated[bool, Parameter(name=all)]
|
Include all seismograms in MCCC processing, not just the currently selected ones. |
False
|
Source code in src/aimbat/_cli/align.py
common
Common parameters and functions for the AIMBAT CLI.
Classes:
| Name | Description |
|---|---|
CliHints |
Hints for error messages. |
DebugTrait |
DebugTrait(debug: bool = False) |
EventContextTrait |
EventContextTrait(event_id: Annotated[uuid.UUID | None, Parameter(name=('event', 'event-id'), converter= |
GlobalParameters |
GlobalParameters(event_id: Annotated[uuid.UUID | None, Parameter(name=('event', 'event-id'), converter= |
IccsPlotParameters |
IccsPlotParameters(context: bool = True, all: bool = False) |
TableParameters |
TableParameters(short: bool = True) |
Functions:
| Name | Description |
|---|---|
id_parameter |
Create a Parameter for a record ID with automatic UUID prefix resolution. |
simple_exception |
Decorator to handle exceptions and print them to the console. |
use_event_parameter |
Create a Parameter for --use-event with automatic UUID prefix resolution. |
use_station_parameter |
Create a Parameter for --use-station with automatic UUID prefix resolution. |
CliHints
dataclass
Hints for error messages.
Source code in src/aimbat/_cli/common.py
DebugTrait
dataclass
DebugTrait(debug: bool = False)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
debug
|
bool
|
Enable verbose logging for troubleshooting. |
False
|
Attributes:
| Name | Type | Description |
|---|---|---|
debug |
bool
|
Enable verbose logging for troubleshooting. |
Source code in src/aimbat/_cli/common.py
debug
class-attribute
instance-attribute
debug: bool = False
Enable verbose logging for troubleshooting.
EventContextTrait
dataclass
EventContextTrait(event_id: Annotated[uuid.UUID | None, Parameter(name=('event', 'event-id'), converter=
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_id
|
UUID | None
|
|
None
|
Source code in src/aimbat/_cli/common.py
GlobalParameters
dataclass
Bases: DebugTrait, EventContextTrait
GlobalParameters(event_id: Annotated[uuid.UUID | None, Parameter(name=('event', 'event-id'), converter=
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_id
|
UUID | None
|
|
None
|
debug
|
bool
|
Enable verbose logging for troubleshooting. |
False
|
Attributes:
| Name | Type | Description |
|---|---|---|
debug |
bool
|
Enable verbose logging for troubleshooting. |
Source code in src/aimbat/_cli/common.py
debug
class-attribute
instance-attribute
debug: bool = False
Enable verbose logging for troubleshooting.
IccsPlotParameters
dataclass
IccsPlotParameters(context: bool = True, all: bool = False)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
bool
|
Plot seismograms with extra context instead of the short tapered ones used for cross-correlation. |
True
|
all
|
bool
|
Include all seismograms in the plot, even if not used in stack. |
False
|
Attributes:
| Name | Type | Description |
|---|---|---|
all |
bool
|
Include all seismograms in the plot, even if not used in stack. |
context |
bool
|
Plot seismograms with extra context instead of the short tapered ones used for cross-correlation. |
Source code in src/aimbat/_cli/common.py
TableParameters
dataclass
id_parameter
id_parameter(model_class: type) -> Parameter
Create a Parameter for a record ID with automatic UUID prefix resolution.
Source code in src/aimbat/_cli/common.py
simple_exception
Decorator to handle exceptions and print them to the console.
Using this decorator prints only the exception to the console without traceback, and then exits. In debugging mode this decorator returns the callable unchanged.
Source code in src/aimbat/_cli/common.py
use_event_parameter
use_event_parameter(model_class: type) -> Parameter
Create a Parameter for --use-event with automatic UUID prefix resolution.
Source code in src/aimbat/_cli/common.py
use_station_parameter
use_station_parameter(model_class: type) -> Parameter
Create a Parameter for --use-station with automatic UUID prefix resolution.
Source code in src/aimbat/_cli/common.py
data
Manage data sources in an AIMBAT project.
A data source is a file that AIMBAT reads seismogram waveforms and metadata from. When a data source is added, AIMBAT extracts and stores the associated station, event, and seismogram records in the project database — provided the data type supports it.
Supported data types (--type):
sac(default): SAC waveform file. Extracts station, event, and seismogram data automatically.json_station: JSON file containing station metadata only. No seismogram is created.json_event: JSON file containing event metadata only. No seismogram is created.
Typical workflow:
aimbat project create
aimbat data add *.sac
aimbat event list # find the event ID
aimbat event default <ID>
Re-adding a data source that is already in the project is safe — existing records are reused rather than duplicated.
Functions:
| Name | Description |
|---|---|
cli_data_add |
Add or update data sources in the AIMBAT project. |
cli_data_dump |
Dump the contents of the AIMBAT data source table to JSON. |
cli_data_list |
Print a table of data sources registered in the AIMBAT project. |
cli_data_add
cli_data_add(
data_sources: Annotated[
list[Path],
Parameter(
name=sources,
consume_multiple=True,
validator=Path(exists=True),
),
],
*,
data_type: Annotated[
DataType, Parameter(name=type)
] = SAC,
station_id: Annotated[
UUID | None, use_station_parameter(AimbatStation)
] = None,
event_id: Annotated[
UUID | None, use_event_parameter(AimbatEvent)
] = None,
dry_run: Annotated[
bool, Parameter(name=dry - run)
] = False,
show_progress_bar: Annotated[
bool, Parameter(name=progress)
] = True,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Add or update data sources in the AIMBAT project.
Each data source is processed according to --type. For sac (the
default), AIMBAT extracts station, event, and seismogram metadata directly
from the file. For types that cannot extract a station or event (e.g. a
format that only carries waveform data), supply --use-station and/or
--use-event to link to records that already exist in the project.
Station and event deduplication is automatic: if a matching record already
exists it is reused. Re-running data add on the same files is safe.
Use --dry-run to preview what would be added without touching the
database.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_sources
|
Annotated[list[Path], Parameter(name=sources, consume_multiple=True, validator=Path(exists=True))]
|
One or more data source paths to add. |
required |
data_type
|
Annotated[DataType, Parameter(name=type)]
|
Format of the data sources. Determines which metadata (station, event, seismogram) can be extracted automatically. |
SAC
|
dry_run
|
Annotated[bool, Parameter(name=dry - run)]
|
Preview which records would be added without modifying the database. |
False
|
show_progress_bar
|
Annotated[bool, Parameter(name=progress)]
|
Display a progress bar while ingesting sources. |
True
|
Source code in src/aimbat/_cli/data.py
cli_data_dump
cli_data_dump(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Dump the contents of the AIMBAT data source table to JSON.
Output can be piped or redirected for use in external tools or scripts.
Source code in src/aimbat/_cli/data.py
cli_data_list
cli_data_list(
*,
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Print a table of data sources registered in the AIMBAT project.
Source code in src/aimbat/_cli/data.py
event
View and manage events in the AIMBAT project.
Functions:
| Name | Description |
|---|---|
cli_event_default |
Select the event to be default for processing. |
cli_event_delete |
Delete existing event. |
cli_event_dump |
Dump the contents of the AIMBAT event table to JSON. |
cli_event_list |
Print a table of events stored in the AIMBAT project. |
cli_event_parameter_dump |
Dump event parameter table to json. |
cli_event_parameter_get |
Get parameter value for an event. |
cli_event_parameter_list |
List processing parameter values for the default event. |
cli_event_parameter_set |
Set parameter value for an event. |
cli_event_default
cli_event_default(
new_default_event_id: Annotated[
UUID, id_parameter(AimbatEvent)
],
*,
global_parameters: DebugTrait = DebugTrait()
) -> None
Select the event to be default for processing.
Source code in src/aimbat/_cli/event.py
cli_event_delete
cli_event_delete(
event_id: Annotated[UUID, id_parameter(AimbatEvent)],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Delete existing event.
Source code in src/aimbat/_cli/event.py
cli_event_dump
cli_event_dump(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Dump the contents of the AIMBAT event table to JSON.
Output can be piped or redirected for use in external tools or scripts.
Source code in src/aimbat/_cli/event.py
cli_event_list
cli_event_list(
*,
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Print a table of events stored in the AIMBAT project.
The default event is highlighted. Use event default to change which event
is processed by subsequent commands.
Source code in src/aimbat/_cli/event.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | |
cli_event_parameter_dump
cli_event_parameter_dump(
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
global_parameters: GlobalParameters = GlobalParameters(),
) -> None
Dump event parameter table to json.
Source code in src/aimbat/_cli/event.py
cli_event_parameter_get
cli_event_parameter_get(
name: EventParameter,
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Get parameter value for an event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
EventParameter
|
Event parameter name. |
required |
Source code in src/aimbat/_cli/event.py
cli_event_parameter_list
cli_event_parameter_list(
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
global_parameters: GlobalParameters = GlobalParameters(),
table_parameters: TableParameters = TableParameters(),
) -> None
List processing parameter values for the default event.
Displays all event-level parameters (e.g. time window, bandpass filter settings, minimum ccnorm) in a table.
Source code in src/aimbat/_cli/event.py
cli_event_parameter_set
cli_event_parameter_set(
name: EventParameter,
value: str,
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Set parameter value for an event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
EventParameter
|
Event parameter name. |
required |
value
|
str
|
Event parameter value. For timedelta parameters, bare numbers are interpreted as seconds. |
required |
Source code in src/aimbat/_cli/event.py
pick
Interactively pick phase arrival times and processing parameters.
These commands open an interactive matplotlib plot for the default event.
Click on the plot to set the chosen value, then close the window to save it.
Use aimbat event default to switch the default event before picking.
Functions:
| Name | Description |
|---|---|
cli_pick_min_ccnorm |
Interactively pick a new minimum cross-correlation norm for auto-selection. |
cli_pick_timewindow |
Interactively pick a new cross-correlation time window for an event. |
cli_update_phase_pick |
Interactively pick a new phase arrival time (t1) for the default event. |
cli_pick_min_ccnorm
cli_pick_min_ccnorm(
*,
iccs_parameters: IccsPlotParameters = IccsPlotParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Interactively pick a new minimum cross-correlation norm for auto-selection.
Opens an interactive plot; click to set the ccnorm threshold. Seismograms
whose cross-correlation with the stack falls below this value will be
automatically de-selected when running ICCS with --autoselect.
Source code in src/aimbat/_cli/pick.py
cli_pick_timewindow
cli_pick_timewindow(
*,
iccs_parameters: IccsPlotParameters = IccsPlotParameters(),
use_seismogram_image: Annotated[
bool, Parameter(name=img)
] = False,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Interactively pick a new cross-correlation time window for an event.
Opens an interactive plot; click to set the left and right window boundaries, then close the window to save. The window controls which portion of the seismogram is used during ICCS alignment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_seismogram_image
|
Annotated[bool, Parameter(name=img)]
|
Use the seismogram image to pick the time window. |
False
|
Source code in src/aimbat/_cli/pick.py
cli_update_phase_pick
cli_update_phase_pick(
*,
iccs_parameters: IccsPlotParameters = IccsPlotParameters(),
use_seismogram_image: Annotated[
bool, Parameter(name=img)
] = False,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Interactively pick a new phase arrival time (t1) for the default event.
Opens an interactive plot; click on the waveform to place the new pick,
then close the window to save. The pick is stored as t1 for each
selected seismogram.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_seismogram_image
|
Annotated[bool, Parameter(name=img)]
|
Use the seismogram image to update pick. |
False
|
Source code in src/aimbat/_cli/pick.py
plot
Create plots for seismograms and ICCS results.
Available plots:
- data: raw seismograms sorted by epicentral distance
- stack: the ICCS cross-correlation stack for the default event
- image: seismograms displayed as a 2-D image (wiggle plot)
Most plot commands support --context / --no-context to toggle extra
waveform context, and --all to include de-selected seismograms.
Functions:
| Name | Description |
|---|---|
cli_iccs_plot_image |
Plot the ICCS seismograms of an event as an image. |
cli_iccs_plot_stack |
Plot the ICCS stack of an event. |
cli_seismogram_plot |
Plot raw seismograms for the default event sorted by epicentral distance. |
cli_iccs_plot_image
cli_iccs_plot_image(
*,
iccs_parameters: IccsPlotParameters = IccsPlotParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Plot the ICCS seismograms of an event as an image.
Source code in src/aimbat/_cli/plot.py
cli_iccs_plot_stack
cli_iccs_plot_stack(
*,
iccs_parameters: IccsPlotParameters = IccsPlotParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Plot the ICCS stack of an event.
Source code in src/aimbat/_cli/plot.py
cli_seismogram_plot
cli_seismogram_plot(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Plot raw seismograms for the default event sorted by epicentral distance.
Source code in src/aimbat/_cli/plot.py
project
Manage AIMBAT projects.
This command manages projects. By default, the project consists
of a file called aimbat.db in the current working directory. All aimbat
commands must be executed from the same directory. The location (and name) of
the project file may also be specified by setting the AIMBAT_PROJECT
environment variable to the desired filename. Alternatively, aimbat can be
executed with a database url directly.
Functions:
| Name | Description |
|---|---|
cli_project_create |
Create a new AIMBAT project in the current directory. |
cli_project_delete |
Delete project (note: this does not delete seismogram files). |
cli_project_info |
Show information on an existing project. |
cli_project_create
cli_project_create(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Create a new AIMBAT project in the current directory.
Initialises a new project database (aimbat.db by default). Run this
once before adding data with aimbat data add.
Source code in src/aimbat/_cli/project.py
cli_project_delete
cli_project_delete(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Delete project (note: this does not delete seismogram files).
Source code in src/aimbat/_cli/project.py
cli_project_info
cli_project_info(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Show information on an existing project.
Source code in src/aimbat/_cli/project.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | |
seismogram
View and manage seismograms in the AIMBAT project.
Functions:
| Name | Description |
|---|---|
cli_seismogram_delete |
Delete existing seismogram. |
cli_seismogram_dump |
Dump the contents of the AIMBAT seismogram table to JSON. |
cli_seismogram_list |
Print information on the seismograms in an event. |
cli_seismogram_parameter_dump |
Dump seismogram parameter table to json. |
cli_seismogram_parameter_get |
Get the value of a processing parameter. |
cli_seismogram_parameter_list |
List processing parameter values for seismograms in an event. |
cli_seismogram_parameter_reset |
Reset all processing parameters to their default values. |
cli_seismogram_parameter_set |
Set value of a processing parameter. |
cli_seismogram_delete
cli_seismogram_delete(
seismogram_id: Annotated[
UUID, id_parameter(AimbatSeismogram)
],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Delete existing seismogram.
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_dump
cli_seismogram_dump(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Dump the contents of the AIMBAT seismogram table to JSON.
Output can be piped or redirected for use in external tools or scripts.
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_list
cli_seismogram_list(
*,
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Print information on the seismograms in an event.
Source code in src/aimbat/_cli/seismogram.py
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 | |
cli_seismogram_parameter_dump
cli_seismogram_parameter_dump(
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
global_parameters: GlobalParameters = GlobalParameters(),
) -> None
Dump seismogram parameter table to json.
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_parameter_get
cli_seismogram_parameter_get(
seismogram_id: Annotated[
UUID, id_parameter(AimbatSeismogram)
],
name: SeismogramParameter,
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Get the value of a processing parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
SeismogramParameter
|
Name of the seismogram parameter. |
required |
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_parameter_list
cli_seismogram_parameter_list(
global_parameters: GlobalParameters = GlobalParameters(),
table_parameters: TableParameters = TableParameters(),
) -> None
List processing parameter values for seismograms in an event.
Displays per-seismogram parameters (e.g. select, flip, t1 pick)
in a table. Use seismogram parameter set to modify individual values.
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_parameter_reset
cli_seismogram_parameter_reset(
seismogram_id: Annotated[
UUID, id_parameter(AimbatSeismogram)
],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Reset all processing parameters to their default values.
Source code in src/aimbat/_cli/seismogram.py
cli_seismogram_parameter_set
cli_seismogram_parameter_set(
seismogram_id: Annotated[
UUID, id_parameter(AimbatSeismogram)
],
name: SeismogramParameter,
value: str,
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Set value of a processing parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
SeismogramParameter
|
Name of the seismogram parameter. |
required |
value
|
str
|
Value of the seismogram parameter. |
required |
Source code in src/aimbat/_cli/seismogram.py
snapshot
View and manage snapshots of processing parameters.
A snapshot captures the current event and seismogram processing parameters
(e.g. time window, bandpass filter, picks) so they can be restored later.
Use snapshot create before making experimental changes, and snapshot rollback
to undo them if needed.
Functions:
| Name | Description |
|---|---|
cli_snapshop_delete |
Delete existing snapshot. |
cli_snapshot_create |
Create a new snapshot of current processing parameters. |
cli_snapshot_details |
Print information on the event parameters saved in a snapshot. |
cli_snapshot_dump |
Dump the contents of the AIMBAT snapshot table to json. |
cli_snapshot_list |
Print information on the snapshots for an event. |
cli_snapshot_rollback |
Rollback to snapshot. |
cli_snapshop_delete
cli_snapshop_delete(
snapshot_id: Annotated[
UUID, id_parameter(AimbatSnapshot)
],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Delete existing snapshot.
Source code in src/aimbat/_cli/snapshot.py
cli_snapshot_create
cli_snapshot_create(
comment: str | None = None,
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Create a new snapshot of current processing parameters.
Saves the current event and seismogram parameters for an event so
they can be restored later with snapshot rollback.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
comment
|
str | None
|
Optional description to help identify this snapshot later. |
None
|
Source code in src/aimbat/_cli/snapshot.py
cli_snapshot_details
cli_snapshot_details(
snapshot_id: Annotated[
UUID, id_parameter(AimbatSnapshot)
],
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters(),
) -> None
Print information on the event parameters saved in a snapshot.
Source code in src/aimbat/_cli/snapshot.py
cli_snapshot_dump
cli_snapshot_dump(
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
global_parameters: GlobalParameters = GlobalParameters(),
) -> None
Dump the contents of the AIMBAT snapshot table to json.
Source code in src/aimbat/_cli/snapshot.py
cli_snapshot_list
cli_snapshot_list(
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters(),
) -> None
Print information on the snapshots for an event.
Source code in src/aimbat/_cli/snapshot.py
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | |
cli_snapshot_rollback
cli_snapshot_rollback(
snapshot_id: Annotated[
UUID, id_parameter(AimbatSnapshot)
],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Rollback to snapshot.
Source code in src/aimbat/_cli/snapshot.py
station
View and manage stations.
Functions:
| Name | Description |
|---|---|
cli_station_delete |
Delete existing station. |
cli_station_dump |
Dump the contents of the AIMBAT station table to JSON. |
cli_station_list |
Print information on the stations used in an event. |
cli_station_delete
cli_station_delete(
station_id: Annotated[
UUID, id_parameter(AimbatStation)
],
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Delete existing station.
Source code in src/aimbat/_cli/station.py
cli_station_dump
cli_station_dump(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Dump the contents of the AIMBAT station table to JSON.
Output can be piped or redirected for use in external tools or scripts.
Source code in src/aimbat/_cli/station.py
cli_station_list
cli_station_list(
*,
all_events: Annotated[
bool, ALL_EVENTS_PARAMETER
] = False,
table_parameters: TableParameters = TableParameters(),
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Print information on the stations used in an event.
Source code in src/aimbat/_cli/station.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | |
utils
Utilities for AIMBAT.
Modules:
| Name | Description |
|---|---|
app |
Utilities for AIMBAT. |
sampledata |
Download or delete AIMBAT sample data. |
app
Utilities for AIMBAT.
The utils subcommand contains useful tools that are not strictly part of an AIMBAT workflow.
sampledata
Download or delete AIMBAT sample data.
The sampledata subcommand manages an example dataset that can be used for testing or learning how to use AIMBAT.
The sample data source url can be viewed or changed via aimbat default
<list/set> sampledata_src. Likewise the sample data destination folder
be viewed or changed via aimbat default <list/set> sampledata_dir.
Functions:
| Name | Description |
|---|---|
sampledata_cli_delete |
Recursively delete sample data directory. |
sampledata_cli_download |
Download AIMBAT sample data. |
sampledata_cli_delete
sampledata_cli_delete(
*,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Recursively delete sample data directory.
Source code in src/aimbat/_cli/utils/sampledata.py
sampledata_cli_download
sampledata_cli_download(
*,
force: bool = False,
global_parameters: GlobalParameters = GlobalParameters()
) -> None
Download AIMBAT sample data.
Downloads an example dataset to the directory specified in the
sampledata_dir AIMBAT default variable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
force
|
bool
|
Delete the download directory and re-download." |
False
|