:allow_comments: False

.. _doc_user_manual_batch_mode:

Batch mode
==========

Met.3D features a batch mode for automated image generation from the command line.
It is started by providing a batch mode file via the ``--batch`` command line argument.

.. note::
    Make sure you also specify the datasets that should be loaded with the batch mode via the ``--datasets``
    command line argument.


Batch mode file
---------------

Note that an up-to-date version of the following file is located in the repository
at ``$MET3D_HOME/config/batch_mode.batch.conf.template``.
The batch mode file is structured as follows:

.. code-block:: ini
   :linenos:
   :caption: Batch mode configuration file

    [BatchMode]
    # Specify the animation type to be used in batch mode. Currently, only
    # "timeAnimation" and "cameraSequenceTimeAnimation" are available.
    animation_type=timeAnimation
    # Specify the name of the sync control to be used for the animation.
    synchronization_name=Synchronization
    # Specify the session to load for the batch mode.
    # If set, this overwrites the "default session" setting from the application settings.
    session_file=
    # Start the animation at the most recent available init time of the specified
    # data source, then advance the animation until the start time plus the
    # specified number of seconds has been reached. For example, to create
    # imagery in the range (init time .. +120hours) specify 120*3600s = 432000 sec.
    # If the init time datasource is not set, it will use the most recent init time
    # of the first dataset that is initialized.
    start_at_most_recent_init_time_of_datasource=
    animation_time_range_s=432000
    # The time step between animation steps.
    # If set, this overwrites the time step saved with the session.
    # Available suffix are " years", " months", " days", " hours", " minutes", " seconds".
    animation_time_step=6 hours
    # Specify the directory, where the screenshots from this batch mode run will be
    # saved.
    # If set, overwrites the directory saved in the session.
    screenshot_directory=
    # Specify the screenshot filename template.
    # If set, overwrites the filename template saved in the session.
    screenshot_filename=%fn-met3d-image.%it.%vt.%m
    # The type of image to save.
    # If set, overwrites the value saved with the session.
    # Available are: ".png", ".jpg", ".jpeg", ".bmp", ".webp"
    screenshot_file_extension=.png
    # Overwrite image files if already present?
    overwrite_existing_image_files=true
    # Tell the application to quit after the animation has completed?
    quit_when_completed=true