pyHarm
======

.. py:module:: pyHarm

.. autoapi-nested-parse::

   The pyHarm package is the core of pyHarm. It contains every modules and subpackages for pyHarm to be runnning an analysis.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pyHarm/Analysis/index
   /autoapi/pyHarm/BaseUtilFuncs/index
   /autoapi/pyHarm/CoordinateSystem/index
   /autoapi/pyHarm/Correctors/index
   /autoapi/pyHarm/DofGrabber/index
   /autoapi/pyHarm/DynamicOperator/index
   /autoapi/pyHarm/Elements/index
   /autoapi/pyHarm/Exporter/index
   /autoapi/pyHarm/KinematicConditions/index
   /autoapi/pyHarm/Logger/index
   /autoapi/pyHarm/Maestro/index
   /autoapi/pyHarm/NonLinearSolver/index
   /autoapi/pyHarm/Predictors/index
   /autoapi/pyHarm/Reductors/index
   /autoapi/pyHarm/Solver/index
   /autoapi/pyHarm/StepSizeRules/index
   /autoapi/pyHarm/StopCriterion/index
   /autoapi/pyHarm/Substructures/index
   /autoapi/pyHarm/Systems/index
   /autoapi/pyHarm/_admin_funcs/index
   /autoapi/pyHarm/_config/index
   /autoapi/pyHarm/_kernel_state/index
   /autoapi/pyHarm/_version/index


Attributes
----------

.. autoapisummary::

   pyHarm.__version__
   pyHarm.__package_name__
   pyHarm.__pyHarm_kernel_PID__
   pyHarm.__pyHarm_kernel_UUID__
   pyHarm.__pyHarm_kernel_DATETIME__
   pyHarm.__pyHarm_kernel_config__


Classes
-------

.. autoapisummary::

   pyHarm.Maestro


Functions
---------

.. autoapisummary::

   pyHarm.init_kernel_state
   pyHarm.add_extension_to_kernel_state
   pyHarm.read_extension_from_kernel_state
   pyHarm._load_extensions


Package Contents
----------------

.. py:data:: __version__

.. py:data:: __package_name__
   :value: 'pyHarm'


.. py:function:: init_kernel_state(pid, uuid: str, datetime: init_kernel_state.datetime)

.. py:function:: add_extension_to_kernel_state(pid, loaded_ext)

.. py:function:: read_extension_from_kernel_state(pid)

.. py:function:: _load_extensions(extension_config: dict[str, list[str]], verbose: bool = True)

.. py:data:: __pyHarm_kernel_PID__

.. py:data:: __pyHarm_kernel_UUID__
   :value: ''


.. py:data:: __pyHarm_kernel_DATETIME__

.. py:data:: __pyHarm_kernel_config__

.. py:class:: Maestro(idata: dict)

   Class that reads and launches the pyHarm analysis contained in the provided input file.

   The class is in charge of reading the input file and build the system and the analysis that are requested by the input file.
   The class is in charge of loading the plugins beforehand if some plugins are requested by the input file.
   When operated, the class runs a loop over the analysis required and solve them.

   :param idata: input dictionary describing all the necessary component (analysis, system composition).
   :type idata: dict


   .. py:attribute:: default


   .. py:attribute:: uuid
      :value: ''



   .. py:attribute:: inputData


   .. py:attribute:: exporter


   .. py:attribute:: system


   .. py:attribute:: nls


   .. py:method:: operate(x0=None, **kwargs)

      Loops over the analysis and runs the Solve method associated with the analysis.

      :param x0: initial point from which running the analysis.
      :type x0: None | np.ndarray | str
      :param kwargs: additional keyword arguments.



   .. py:method:: getIndex(sub: str, node: int, dir_num: int) -> numpy.ndarray

      From a substructure name, a node number, and a direction; returns the index of the required dof into the explicit dof vector of the system.

      :param sub: name of the substructure.
      :type sub: str
      :param node: node number.
      :type node: int
      :param dir_num: direction number.
      :type dir_num: int

      Returns :
          np.ndarray : sorted array of the dof index associated with the input in the explicit dof DataFrame of the system.