swick 0.28

The slick way to process SWC files.

swick is the slick way to process SWC files—which contain tree-like representations of neuron structures—in Python.

Reading, writing, combining, splitting, and validating SWC files can be done in just a few lines. Objects to represent SWC files are also provided, laying the groundwork for custom analysis or modification of SWCs in Python.

Installation

To install swick via pip, simply:

pip install swick

Or to upgrade an existing installation:

pip install swick --upgrade

Python wheels can also be manually downloaded via the PyPI page.

Usage & Documentation

Documentation is automatically built via a Github Actions workflow and hosted on Github Pages. Reading it is the best way to get started with swick. For any questions not addressed there, please feel free to open an issue!

Here are some links to relevant documentation:

• Documentation Homepage
• User Guide
• API Reference

Testing

Tests can be run via this command from the root directory of the repository:

python -m unittest discover

In the near future, tests will be automated via Github Actions in order to evaluate pull requests as well as the current head of the main branch.