.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/gallery_examples/run_python_script/05_optimizer_settings.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_examples_run_python_script_05_optimizer_settings.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_examples_run_python_script_05_optimizer_settings.py:


.. _ref_optimizer_settings:

Optimizer settings
------------------

This example demonstrates how to create and configure optimizer systems.

It uses the ``optimizer_settings.py`` file to create,
configure, and insert an EA (Evolutionary Algorithm) optimizer
into the scenery. It then explains how you can optionally save
the project to a desired location.

.. GENERATED FROM PYTHON SOURCE LINES 36-45

.. code-block:: Python


    # Perform required imports
    # ~~~~~~~~~~~~~~~~~~~~~~~~
    # Perform the required imports.


    from ansys.optislang.core import Optislang
    import ansys.optislang.core.examples as examples


.. GENERATED FROM PYTHON SOURCE LINES 49-52

Create optiSLang instance
~~~~~~~~~~~~~~~~~~~~~~~~~
Create the optiSLang instance.

.. GENERATED FROM PYTHON SOURCE LINES 52-56

.. code-block:: Python


    osl = Optislang(ini_timeout=60)
    print(osl)


.. GENERATED FROM PYTHON SOURCE LINES 57-61

Get path of example script and run it
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the path of the example script and then run this
script.

.. GENERATED FROM PYTHON SOURCE LINES 61-65

.. code-block:: Python


    paths = examples.get_files("optimizer_settings")
    osl.application.project.run_python_file(paths[0])


.. GENERATED FROM PYTHON SOURCE LINES 66-76

Optionally save project
~~~~~~~~~~~~~~~~~~~~~~~
If you want to save the project to some desired
location, uncomment and edit these lines:

.. code:: python

  path = r'<insert-desired-location>'
  osl.application.save_as(os.path.join(path, "test_project.opf"))


.. GENERATED FROM PYTHON SOURCE LINES 78-81

Stop and cancel project
~~~~~~~~~~~~~~~~~~~~~~~
Stop and cancel the project.

.. GENERATED FROM PYTHON SOURCE LINES 81-84

.. code-block:: Python


    osl.dispose()


.. GENERATED FROM PYTHON SOURCE LINES 85-93

View generated workflow
~~~~~~~~~~~~~~~~~~~~~~~
This image shows the generated workflow.

.. image:: ../../../_static/05_optimizer_settings.png
 :width: 300
 :alt: Result of script.



.. _sphx_glr_download_examples_gallery_examples_run_python_script_05_optimizer_settings.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: 05_optimizer_settings.ipynb <05_optimizer_settings.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: 05_optimizer_settings.py <05_optimizer_settings.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: 05_optimizer_settings.zip <05_optimizer_settings.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_