-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,22 @@ | ||
[![Python code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black "Black: The Uncompromising Code Formatter") | ||
![Docs](https://github.com/gerlichlab/spoc/actions/workflows/build_pages.yml/badge.svg) | ||
![Code style](https://github.com/gerlichlab/spoc/actions/workflows/black_lint_test.yml/badge.svg) | ||
[![license](https://img.shields.io/github/license/pydantic/pydantic.svg)](https://github.com/pydantic/pydantic/blob/main/LICENSE) | ||
|
||
# Spoc | ||
|
||
Spoc is a toolbox for analyzing higher-order contact data from pore-c experiments. It is capable of handling sister-specific contact information to use in the context of sister-sensitive pore-c experiments. | ||
|
||
## Installation | ||
|
||
The easiest way to install spoc is to use pip: | ||
|
||
``` | ||
pip install git+https://github.com/gerlichlab/spoc | ||
``` | ||
|
||
## Getting started | ||
|
||
To get started, have a look at our example notebooks, that cover different aspects of spoc's capabilities: | ||
|
||
- [Snipping interface](./notebooks/snipping.ipynb) | ||
|
||
## Documentation | ||
|
||
* Documentation: https://spoc.readthedocs.io. | ||
|
||
## Development information | ||
Documentation can be found [here](https://gerlichlab.github.io/spoc/) | ||
|
||
The development principles are summarized [here](docs/dev_notes.md). | ||
## Contributions | ||
|
||
## License | ||
|
||
* Free software: MIT license | ||
Contributions are welcome! Please follow the guidelines in [here](https://gerlichlab.github.io/spoc/contributing/) to contribute to this project. | ||
|
||
## Credits | ||
|
||
This package was created with Cookiecutter and the `audreyr/cookiecutter-pypackage` project template. | ||
## License | ||
|
||
* Cookiecutter: https://github.com/audreyr/cookiecutter | ||
* `audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage | ||
* Free software: MIT license |