paroto.models.registry
======================

.. py:module:: paroto.models.registry

.. autoapi-nested-parse::

   Model registry for managing available models.



Classes
-------

.. autoapisummary::

   paroto.models.registry.ModelRegistry


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

.. py:class:: ModelRegistry

   Registry for managing available physics models.

   This class maintains a registry of all available models for different
   physical phenomena, allowing users to select models by name.


   .. py:method:: register(category, model_class)
      :classmethod:


      Register a model class.

      :param category: Model category (e.g., 'breakdown_voltage', 'ablation')
      :type category: :py:class:`str`
      :param model_class: Model class to register
      :type model_class: :py:class:`Type[BaseModel]`



   .. py:method:: get_model(category, model_name)
      :classmethod:


      Get a model class by category and name.

      :param category: Model category
      :type category: :py:class:`str`
      :param model_name: Model name
      :type model_name: :py:class:`str`

      :returns: **model_class** -- Model class if found, None otherwise
      :rtype: :py:class:`Type[BaseModel]` or :py:obj:`None`



   .. py:method:: list_models(category)
      :classmethod:


      List all models in a category.

      :param category: Model category
      :type category: :py:class:`str`

      :returns: **models** -- Dictionary of model names to model classes
      :rtype: :py:class:`dict`



   .. py:method:: list_categories()
      :classmethod:


      List all available model categories.

      :returns: **categories** -- List of category names
      :rtype: :py:class:`list`



   .. py:method:: create_model(category, model_name, parameters = None)
      :classmethod:


      Create a model instance.

      :param category: Model category
      :type category: :py:class:`str`
      :param model_name: Model name
      :type model_name: :py:class:`str`
      :param parameters: Model parameters
      :type parameters: :py:class:`dict`, *optional*

      :returns: **model** -- Model instance
      :rtype: :py:class:`BaseModel`

      :raises ValueError: If model not found