:py:mod:`wolfgpu.cli`
=====================

.. py:module:: wolfgpu.cli

.. autoapi-nested-parse::

   Author: HECE - University of Liege, Stéphane Champailler, Pierre Archambeau
   Date: 2024

   Copyright (c) 2024 University of Liege. All rights reserved.

   This script and its content are protected by copyright law. Unauthorized
   copying or distribution of this file, via any medium, is strictly prohibited.



Module Contents
---------------

.. py:data:: VERSION

   

.. py:data:: DATA_DIR

   

.. py:data:: WOLF_CLI_EXE

   

.. py:data:: BENCHMARK_AGGREGATED_RESULT_FILE

   

.. py:data:: BIG_TEST

   

.. py:data:: POWER_MODE

   

.. py:data:: LOGOS
   :value: [' __    __      _  __   ___   ___\n/ / /\\ \\ \\___ | |/ _| / _ \\ / _ \\/\\ /\\\n\\ \\/  \\/ /...

   

.. py:function:: write_wolf_array(wa, generic_name: pathlib.Path)


.. py:class:: Scenario


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfgpu.cli.Scenario
      :parts: 1
      :private-bases:

   Generic enumeration.

   Derive from this class to define new enumerations.

   .. py:attribute:: TWO_ROOMS
      :value: 1

      

   .. py:attribute:: SWIMMING_POOL_WITH_HOLE
      :value: 2

      

   .. py:attribute:: TWO_SMALL_ROOMS
      :value: 3

      

   .. py:attribute:: LINEAR
      :value: 4

      


.. py:function:: bbox2(img)


.. py:function:: bounding_polygon_xy(wa: wolfhece.wolf_array.WolfArray)


.. py:function:: mask_border(wa: wolfhece.wolf_array.WolfArray)

   Set a new mask applying only to a one cell around
   the matrix. It is usefule because SUXY is not smart
   enough to handle borders which are on the very border
   of matrices.


.. py:function:: run_wolf_cli(destination_dir: pathlib.Path)


.. py:function:: force_cli_params_in_wolf_model(cli_args: argparse.Namespace, m: wolfhece.mesh2d.wolf2dprev.prev_sim2D)


.. py:function:: force_params_in_gpu(cli_args: argparse.Namespace, gpu: wolfgpu.glsimulation.GLSimulation)


.. py:function:: print_sim_params(sim: wolfgpu.glsimulation.GLSimulation, runner: wolfgpu.SimulationRunner.SimulationRunner, manning: numpy.array, active: numpy.array, h: numpy.array)


.. py:function:: benchmark(destination_dir, cli_args)


.. py:function:: main_func()