Helper
======

.. currentmodule:: optking.opt_helper

.. autoclass:: Helper
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Helper.E
      ~Helper.HX
      ~Helper.gX
      ~Helper.geom

   .. rubric:: Methods Summary

   .. autosummary::

      ~Helper.attempt_fromiter
      ~Helper.build_coordinates
      ~Helper.close
      ~Helper.compute
      ~Helper.from_dict
      ~Helper.post_step_str
      ~Helper.pre_step_str
      ~Helper.show
      ~Helper.status
      ~Helper.summarize_result
      ~Helper.take_step
      ~Helper.test_convergence
      ~Helper.to_dict

   .. rubric:: Attributes Documentation

   .. autoattribute:: E
   .. autoattribute:: HX
   .. autoattribute:: gX
   .. autoattribute:: geom

   .. rubric:: Methods Documentation

   .. automethod:: attempt_fromiter
   .. automethod:: build_coordinates
   .. automethod:: close
   .. automethod:: compute
   .. automethod:: from_dict
   .. automethod:: post_step_str
   .. automethod:: pre_step_str
   .. automethod:: show
   .. automethod:: status
   .. automethod:: summarize_result
   .. automethod:: take_step
   .. automethod:: test_convergence
   .. automethod:: to_dict