|

.. image:: media/gearpath.svg
  :width: 400
  :align: center
  :alt: Image of a sequence of gears, each bigger than the last.

|

EvoKit Documentation
====================

**EvoKit** is an evolutionary computation framework written in Python. The framework can implement a large range of interoperating representations and operators.

Using EvoKit is easy! With all operators defined, you can run an evolutionary algorithm in just 7 lines! [#]_ [#]_

.. code-block:: ruby
   :linenos:

   ctrl: SimpleLinearController = SimpleLinearConstroller(
      population=init_pop,
      variator=RandomBitMutator(0.1),
      selector=Elitist(SimpleSelector[BinaryString](POPULATION_SIZE)),
      evaluator = BitDistanceEvaluator()
   )

   for _ in range(GENERATION_COUNT):
      ctrl.step()


---------------

.. toctree::
   :maxdepth: 2
   :caption: Getting Started:

   why
   install-and-built
   guides/index

.. toctree::
   :maxdepth: 2
   :caption: API Reference:

   modules



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. [#] Example Derived from :doc:`guides/examples/onemax`
.. [#] Technically 9 lines including the parenthesis and an empty line