Metadata-Version: 2.4
Name: maphelios
Version: 0.8.5
Summary: Package for making genome related plots
Author-email: Bartosz Bartmanski <bartosz.bartmanski@embl.de>, Katarina Erbstein <katarina.erbstein@embl.de>
License: MIT License
        
        Copyright (c) 2024 Zimmermann-Kogadeeva Group
        
        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.
        
Project-URL: Homepage, https://git.embl.de/grp-zimmermann-kogadeeva/Maphelios
Project-URL: Bug tracker, https://git.embl.de/grp-zimmermann-kogadeeva/Maphelios/issues/
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: biopython
Requires-Dist: bcbio-gff
Requires-Dist: dna_features_viewer
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: platformdirs
Requires-Dist: pysam>=0.23.0
Requires-Dist: pycirclize>=1.9.1
Requires-Dist: scipy>=1.13.1
Provides-Extra: streamlit
Requires-Dist: streamlit; extra == "streamlit"
Requires-Dist: seaborn; extra == "streamlit"
Dynamic: license-file


# Maphelios

Package to find and plot inserts alongside the genome or contigs.

BLAST is required. You can follow the instructions to download and install
BLAST
[here](https://blast.ncbi.nlm.nih.gov/doc/blast-help/downloadblastdata.html). 

## Installation

```
pip install git+https://git.embl.org/grp-zimmermann-kogadeeva/Maphelios.git
```

## Running

### Docker

To run the streamlit app with docker:
```
docker run -it --rm -p 8501:8501 docker://registry.git.embl.org/grp-zimmermann-kogadeeva/maphelios:0.7.3
```

### Apptainer

To run the streamlit app with apptainer:
```
apptainer exec --no-home --writable-tmpfs --workdir /app docker://registry.git.embl.org/grp-zimmermann-kogadeeva/maphelios:0.7.3 streamlit run /app/app/app.py --server.headless true
```

