==========================
The ``environment`` module
==========================

This module is used to create and manage spatial environments where the neurons
can develop.

.. warning::

    For people using |name| from git, this module is remotely tracked from SENeC
    PyNCulture_ repository, which means that you have to initialize and pull it
    separately.
    The first time, the repository must also be initialized with ::

        git submodule init
        git submodule update
    
    To update it later on, just run ::

        git submodule update --remote --merge


The module contains the following functions and classes:

.. currentmodule:: environment

.. autosummary::

    dense.environment.Area
    dense.environment.Shape
    dense.environment.culture_from_file
    dense.environment.plot_shape
    dense.environment.pop_largest
    dense.environment.shapes_from_file


.. automodule:: dense.environment
   :members:
   :undoc-members:
   :show-inheritance:


.. Links

.. _PyNCulture : https://github.com/SENeC-Initiative/PyNCulture