.. Neuroptimus documentation master file, created by
   sphinx-quickstart on Tue Aug 29 15:59:09 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome the documentation of Neuroptimus!
=========================================


Neuroptimus is an open-source framework for solving parameter optimization problems, with many additional features (including a GUI) to support typical use cases in neuroscience.
To install Neuroptimus, please visit the GitHub repository https://github.com/KaliLab/neuroptimus . 
The neuroptimus/new_test_files folder in the repository contains several examples of using Neuroptimus, with detailed PDF guides to setting up and running these use cases in the Neuroptimus GUI.


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

   install
   running
   tutorial
   devs

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

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