Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 2.36 KB

index.rst

File metadata and controls

78 lines (61 loc) · 2.36 KB

pymaid: a Python-CATMAID interface

pymaid (short for "Python-CATMAID") is a Python library for fetching, analyzing and visualizing data generated with CATMAID.

pymaid is built on top of navis and is fully compatible with its functions.

For a brief introduction to the library, you can read the :ref:`tutorial <tutorial>`. Visit the :ref:`installation page <installing>` page to see how to download the package. You can browse the :ref:`example gallery <example_gallery>` and :ref:`API reference <api>` to learn what you can do with pymaid.

Pymaid is licensed under the GNU GPL v3+ license. The source code is hosted at Github. Feedback, feature requests and bug reports are very welcome and best placed in issues. If you have any questions, please don't hesitate: [email protected]

The package is stable but I recommend watching its Github repository for updates. Make sure that your pymaid.__version__ is up-to-date and check out the :ref:`release notes <whats_new>`.

Contents

.. toctree::
   :maxdepth: 1

   source/whats_new
   source/install
   source/intro.ipynb
   examples/examples_index
   source/troubleshooting
   source/api

Features

  • fetch data directly from CATMAID server
  • write data (e.g. annotations, tags, neurons) to the server
  • fully compatible with navis
  • high-level functions to analyze e.g. connectivity