spellmatch 0.1.0

Spatial cell representation matching

spellmatch

Spatial cell representation matching

Documentation is available at https://bodenmillergroup.github.io/spellmatch

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Extending spellmatch

Spellmatch uses pluggy to discover and interface with plugins.

Currently, spellmatch supports the addition of custom mask matching algorithms. To add your mask matching algorithm to spellmatch, create a Python package named spellmatch-youralgorithm, configure your setuptools entrypoint for pluggy, and implement the spellmatch.hookspecs.spellmatch_get_mask_matching_algorithm hook.

Please refer to the spellmatch reference documentation for further details.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.1.0 - 2022-05-19

Initial release

MIT License

Copyright (c) 2022 University of Zurich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.