Metadata-Version: 2.1
Name: bolero
Version: 0.0.5
Summary: sequence
Project-URL: Documentation, https://bolero.readthedocs.io/
Project-URL: Source, https://github.com/lhqing/bolero
Project-URL: Home-page, https://github.com/lhqing/bolero
Author: Hanqing Liu, Hanchen Wang
Maintainer-email: Hanqing Liu <hanqingliu@fas.harvard.edu>, Hanchen Wang <hanchenw.au@gmail.com>
License: MIT License
        
        Copyright (c) 2024, Hanqing Liu
        
        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.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: anndata
Requires-Dist: biopython
Requires-Dist: deeptools
Requires-Dist: pyfaidx
Requires-Dist: pyranges
Requires-Dist: seaborn
Requires-Dist: session-info
Requires-Dist: tqdm
Requires-Dist: xarray
Requires-Dist: zarr
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: doc
Requires-Dist: docutils!=0.18.*,!=0.19.*,>=0.8; extra == 'doc'
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipython; extra == 'doc'
Requires-Dist: myst-nb; extra == 'doc'
Requires-Dist: pandas; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-book-theme>=1.0.0; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx>=4; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex>=1.0.0; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# bolero

[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/lhqing/bolero/test.yaml?branch=main
[link-tests]: https://github.com/lhqing/bolero/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/bolero

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

-   [API documentation][link-api].

## Installation

You need to have Python 3.10 or newer installed on your system. If you don't have
Python installed, we recommend installing [Miniforge](https://github.com/conda-forge/miniforge).

```bash
# 1. Download the environment YAML file
wget https://raw.githubusercontent.com/lhqing/commons/main/envs/bolero_env.yaml

# 2. Create a environment named bolero
mamba env create -f bolero_env.yaml
# OR if you use conda
# conda env create -f bolero_env.yaml
# Note that conda can be very slow in solving complex dependencies

# 3. Install this package
pip install bolero

# or install the package with dev mode
git clone https://github.com/lhqing/bolero.git
cd bolero
pip install -e ".[dev,test]"
```

## Release notes

See the [changelog][changelog].

## Contact

If you found a bug, please use the [issue tracker][issue-tracker].

## Citation

> t.b.a

[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/lhqing/bolero/issues
[changelog]: https://bolero.readthedocs.io/latest/changelog.html
[link-docs]: https://bolero.readthedocs.io
[link-api]: https://bolero.readthedocs.io/latest/api.html
