.. auto-AUTO documentation master file, created by
   sphinx-quickstart on Fri Feb 14 12:01:04 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================
auto-AUTO (or AUTO²)
====================

AUTO² or auto-AUTO is an |AUTO| automatic search algorithm codebase
to enhance the original AUTO-07p Python interface with a top layer.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   files/general_information
   files/rationale
   files/user_guide
   files/references

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

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

About
=====

Please consult the auto-AUTO `code repository <http://www.github.com/Climdyn/auto-AUTO>`_ for updates.


auto-AUTO is licensed under the `MIT`_ license:

.. code-block:: none

   The MIT License (MIT)

   Copyright (c) 2025 Jonathan Demaeyer and Oísin Hamilton.


   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.


.. _MIT: https://opensource.org/licenses/MIT
.. _Jupyter: https://jupyter.org/