https://github.com/citiususc/veryfasttree-python
VeryFastTree Python Bindings
https://github.com/citiususc/veryfasttree-python
Last synced: about 1 year ago
JSON representation
VeryFastTree Python Bindings
- Host: GitHub
- URL: https://github.com/citiususc/veryfasttree-python
- Owner: citiususc
- License: gpl-3.0
- Created: 2024-06-11T20:13:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T11:01:15.000Z (over 1 year ago)
- Last Synced: 2025-01-29T19:23:53.058Z (over 1 year ago)
- Language: Python
- Homepage: https://github.com/citiususc/veryfasttree
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VeryFastTree Python Bindings
The VeryFastTree Python Bindings provide an interface to the VeryFastTree software for rapid construction of phylogenetic trees. This package allows you to easily integrate VeryFastTree into your Python workflows, enabling efficient handling of large datasets and quick tree generation.
### Installation
To install the VeryFastTree Python Bindings, you can use pip:
```bash
pip install veryfasttree
```
**\*The Linux version requires the OpenMP library (libgomp) to be installed on the system.**
### Usage
Here is a basic example of how to use the VeryFastTree Python Bindings:
```python
import veryfasttree
# Define input file
input_alignment = 'path/to/your/alignment.fasta'
# Run VeryFastTree
tree = veryfasttree.run(input_alignment, gtr=True, nt=True)
print(tree)
```
The input to the function can be a file or a text string containing the aligned sequences. The other function arguments
are the same as the VeryFastTree command-line arguments, omitting the hyphens (-). Flags should be specified with the
value True.
VeryFastTree can also be called using the command line interface provided by the Python module:
```bash
python3 -m veryfasttree [arguments]
```
The command-line arguments follow the same convention as the VeryFastTree.
### Contributing
Contributions are welcome! Please submit pull requests or issues on the
[GitHub repository](https://github.com/citiususc/veryfasttree).