#####################################
Create and register the plugin module
#####################################

.. role:: bash(code)
   :language: bash

Here, one should add the model to the list of model plugins recognized by the CIF.
The list of available plugins can be accessed :doc:`here<../../documentation/plugins/available>`.
General instruction on how to register new plugins are given :doc:`here <../newplugin/newplugin>`.

1. Go to the directory "pycif/plugins/models/"
2. Copy the template to a folder with your model name
3. Edit the __init__.py file and add the following lines:

   .. code-block:: python

       _name = "YOUR MODEL NAME"
       _version = "YOUR MODEL VERSION (optional)"

   When registering, pay attention to not replicate an already existing model!

4. Check that your model is available in pyCIF.
   Your model should appear in the list when typing the following commands in python:

   .. code-block:: python

       from pycif.utils.classes.baseclass import Plugin
       Plugin.print_registered()

5. Check that your model initializes properly using the following yaml and changing
   the ``name`` and ``version`` of your model

   .. literalinclude:: yml/1_register.yml
       :linenos:
       :language: yaml