sme-contrib
===========

A collection of useful modules for use with `sme <https://pypi.org/project/sme/>`_,
the python interface to `Spatial Model Editor <https://spatial-model-editor.readthedocs.io/>`_.

Installation
------------

To install from `PyPI <https://pypi.org/project/sme-contrib/>`_:

.. code-block:: bash

    pip install sme-contrib

API Reference
-------------

.. autosummary::
   :toctree: _autosummary
   :recursive:
   :caption: API Reference

   sme_contrib.optimize
   sme_contrib.plot

.. toctree::
   :maxdepth: 1
   :caption: Example jupyter notebooks

   notebooks/plot
   notebooks/optimize

Source code
-----------

The source code is available from `GitHub <https://github.com/spatial-model-editor/sme_contrib>`_.
and released under a permissive `MIT license <https://github.com/spatial-model-editor/sme_contrib/blob/master/LICENSE>`_.