Metadata-Version: 2.4
Name: poriscope
Version: 1.6.1
Summary: A tool for selecting and analyzing nanopore data.
Author-email: Kyle Briggs & Alejandra Carolina González González <kbriggs@uottawa.ca>
License: MIT
Project-URL: Homepage, https://github.com/TCossaLab/poriscope
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PySide6==6.9.0
Requires-Dist: numpy==2.2.6
Requires-Dist: matplotlib==3.10.3
Requires-Dist: pandas==2.2.3
Requires-Dist: platformdirs==4.3.8
Requires-Dist: scipy==1.15.3
Requires-Dist: kneed==0.8.5
Requires-Dist: fast-histogram==0.14
Requires-Dist: scikit-learn==1.6.1
Requires-Dist: hdbscan==0.8.40
Provides-Extra: dev
Requires-Dist: black==25.1.0; extra == "dev"
Requires-Dist: ruff==0.12.9; extra == "dev"
Requires-Dist: mypy==1.9.0; extra == "dev"
Requires-Dist: pytest==8.4.1; extra == "dev"
Requires-Dist: pytest-mock==3.14.1; extra == "dev"
Requires-Dist: pytest-qt==4.5.0; extra == "dev"
Requires-Dist: pytest-timeout==2.4.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx==8.2.3; extra == "docs"
Requires-Dist: sphinx-tabs==3.4.7; extra == "docs"
Requires-Dist: furo==2024.8.6; extra == "docs"
Dynamic: license-file

## SETUP
Note: Conda is not supported. You can make it work, but you're on your own. 
Make sure you have Python 3.12.10 installed (python --version) to avoid dependencies compatibility issues.

For regular users, you can install the latest stable release of poriscope directly from PyPi using pip or similar. Simply run_

pip install poriscope 

As a developer:

`git clone https://github.com/TCossaLab/poriscope.git`

`cd poriscope`

`pip install -e .`

To use a stable version (does not allow retroactive pulls): 
`python -m pip install -U "git+https://github.com/TCossaLab/poriscope.git@main"`

Then from any cmd you will be able to run the `poriscope` command to open the app.

*If you have a previous version of poriscope installed, make sure to run: 

`pip uninstall poriscope`

## Post-clone Setup dor developers

After cloning this repo, run:

`python scripts/setup_hooks.py (To enable pre-commit and post-merge)`

To emulate a pulled run:
`python .git/hooks/post-merge`

## Documentation can be found
https://tcossalab.github.io/poriscope/ 

## Poriscope Tutorial Series
https://youtube.com/@tcossalab?si=A8Wy8yHOXiwSXu5F 

## Data
Tutorial Series data is available on FRDR: https://doi.org/10.20383/103.01599  
See [`data/README.md`](data/README.md) for download instruction
