.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/Potjans_2014/sim_params.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_Potjans_2014_sim_params.py:

PyNEST Microcircuit: Simulation Parameters
------------------------------------------------

.. only:: html

----

 Run this example as a Jupyter notebook:

  .. card::
    :width: 25%
    :margin: 2
    :text-align: center
    :link: https://lab.ebrains.eu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fnest%2Fnest-simulator-examples&urlpath=lab%2Ftree%2Fnest-simulator-examples%2Fnotebooks%2Fnotebooks%2FPotjans_2014%2Fsim_params.ipynb&branch=main
    :link-alt: JupyterHub service

    .. image:: https://nest-simulator.org/TryItOnEBRAINS.png


.. grid:: 1 1 1 1
   :padding: 0 0 2 0

   .. grid-item::
     :class: sd-text-muted
     :margin: 0 0 3 0
     :padding: 0 0 3 0
     :columns: 4

     See :ref:`our guide <run_jupyter>` for more information and troubleshooting.

----


A dictionary with parameters defining the simulation.

.. GENERATED FROM PYTHON SOURCE LINES 28-64

.. code-block:: Python


    import os

    sim_dict = {
        # The full simulation time is the sum of a presimulation time and the main
        # simulation time.
        # presimulation time (in ms)
        "t_presim": 500.0,
        # simulation time (in ms)
        "t_sim": 1000.0,
        # resolution of the simulation (in ms)
        "sim_resolution": 0.1,
        # list of recording devices, default is 'spike_recorder'. A 'voltmeter' can
        # be added to record membrane voltages of the neurons. Nothing will be
        # recorded if an empty list is given.
        "rec_dev": ["spike_recorder"],
        # path to save the output data
        "data_path": os.path.join(os.getcwd(), "data/"),
        # Seed for NEST
        "rng_seed": 55,
        # Number of threads per MPI process
        #
        # Note that when you scale up the network, the microcircut model
        # may not run correctly if there is < 4 virtual processes
        # (i.e., a thread in an MPI process)
        # If you have 4 or more MPI processes, then you can set this value to 1.
        "local_num_threads": 4,
        # recording interval of the membrane potential (in ms)
        "rec_V_int": 1.0,
        # if True, data will be overwritten,
        # if False, a NESTError is raised if the files already exist
        "overwrite_files": True,
        # print the time progress. This should only be used when the simulation
        # is run on a local machine.
        "print_time": True,
    }


.. _sphx_glr_download_auto_examples_Potjans_2014_sim_params.py:

.. only:: html

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

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

      :download:`Download Jupyter notebook: sim_params.ipynb <sim_params.ipynb>`

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

      :download:`Download Python source code: sim_params.py <sim_params.py>`


.. only:: html

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

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