Skip to content

Commit

Permalink
added quickstart info to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KatyBrown authored Oct 1, 2024
1 parent 9d28bf8 commit 1d0c743
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,29 @@ Or clone the GitHub repository directly.

`git clone [email protected]:KatyBrown/plot_phylo.git`

# Quick Start
For detailed usage instructions, visit our [ReadTheDocs page](https://plot-phylo.readthedocs.io/en/latest/index.html).

To draw a phylogeny under the default settings onto a blank figure.

```
import matplotlib.pyplot as plt
import plot_phylo
# Create an empty plot, 8in (width) by 10in (height) - matplotlib
f = plt.figure(figsize=(8, 10))
# Add an axis - matplotlib
ax = plt.subplot()
# Plot the tree on this axis, using the default settings - plot_phylo
results = plot_phylo.plot_phylo("examples/primates.nw", ax)
# Save the tree - matplotlib
plt.savefig("examples/basic_plot.png", bbox_inches='tight')
```


# Cite

If you use this repository in your work, please cite:
Expand Down

0 comments on commit 1d0c743

Please sign in to comment.