Skip to content

Commit

Permalink
More Citations
Browse files Browse the repository at this point in the history
  • Loading branch information
marcharper committed Jun 11, 2017
1 parent bf49369 commit 26cfbcc
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@


# python-ternary

<a href="https://pypi.python.org/pypi/python-ternary"><img src="https://img.shields.io/pypi/v/python-ternary.svg"/></a>
Expand All @@ -11,8 +10,6 @@ plots in the two dimensional simplex projected onto a two dimensional plane.

The library provides functions for plotting projected lines, curves (trajectories), scatter plots, and heatmaps. There are [several examples](https://github.com/marcharper/python-ternary/blob/master/examples.py) and a short tutorial below.

Some ternary functions expect the simplex to be partititioned into some number of steps, determined by the scale parameter. A few functions will do this partitioning automatically for you, but when working with real data or simulation output, you may have partitioned already. If you are working with probability distributions, just use `scale=1` (the default). Otherwise the scale parameter effectively controls the resolution of many plot types (e.g. heatmaps).

# Gallery

<div style="text-align:center">
Expand All @@ -30,8 +27,22 @@ Some ternary functions expect the simplex to be partititioned into some number o
<br/>
From <a href="http://biorxiv.org/content/early/2017/06/07/145631">Genetic Drift and Selection in Many-Allele Range Expansions</a>:<br/>
<img src="/readme_images/btweinstein_example.png" width="300" height="150"/>
<br/>
See the citations below for more example images.
</div>

# Citations and Recent Usage in Publications:

Have you used python-ternary in a publication? Open a PR or issue to include your citations or example plots!

- [Genetic Drift and Selection in Many-Allele Range Expansions](http://biorxiv.org/content/early/2017/06/07/145631) by [Bryan T. Weinstein](https://github.com/btweinstein) (2017)
- [Gibbs Sampler-Based λ-Dynamics and Rao–Blackwell Estimator for Alchemical Free Energy Calculation](http://pubs.acs.org/doi/abs/10.1021/acs.jctc.7b00204?src=recsys&journalCode=jctcce) by Xinqiang Ding, Jonah Z. Vilseck, Ryan L. Hayes, and Charles L. Brooks (2017)
- Kottke, Daniel, et al. [Multi-class probabilistic active learning](http://ebooks.iospress.nl/publication/44803) Proc. of the 22nd Europ. Conf. on Artificial Intelligence (ECAI2016). 2016.
- [On the origins of three-dimensionality in drug-like molecules](http://www.future-science.com/doi/full/10.4155/fmc-2016-0095) by Joshua Meyers, Michael Carter, N Yi Mok, and Nathan Brown (2016)
- [Stationary Stability for Evolutionary Dynamics in Finite Populations](http://www.mdpi.com/1099-4300/18/9/316/htm) by Marc Harper and Dashiell Fryer. Entropy 18.9 (2016): 316.
- [pyIAST: Ideal adsorbed solution theory (IAST) Python package](http://www.sciencedirect.com/science/article/pii/S0010465515004403) by [Cory Simon](https://github.com/CorySimon) (2016)
- [Lyapunov Functions for Time-Scale Dynamics on Riemannian Geometries of the Simplex](https://link.springer.com/article/10.1007/s13235-014-0124-0) by Marc Harper and Dashiell Fryer. Dynamic Games and Applications (2015)

# Installation

### Anaconda
Expand Down Expand Up @@ -111,7 +122,13 @@ This is useful if you want to use ternary as part of another figure, such as
ax = pyplot.subplot(gs[0,0])
figure, tax = ternary.figure(ax=ax)
...
````
```

Some ternary functions expect the simplex to be partititioned into some number of steps,
determined by the scale parameter. A few functions will do this partitioning automatically
for you, but when working with real data or simulation output, you may have partitioned
already. If you are working with probability distributions, just use `scale=1` (the default).
Otherwise the scale parameter effectively controls the resolution of many plot types (e.g. heatmaps).

`TernaryAxesSubplot` objects keep track of the scale, axes, and other parameters,
supplying them as needed to other functions.
Expand Down Expand Up @@ -269,9 +286,11 @@ vertices
triangles &#9651; and blending the neigboring triangles for the downward
triangles &#9661;
- Hexagonal -- `hexagonal`: which does not blend values at all, and divides
the simplex up into heaxagonal regions
the simplex up into hexagonal regions

The two triangular heatmap styles and the hexagonal heatmap style can be visualized as follows. The `dual-triangular` style plots the true values on the upright triangles, mapping ternary coordinates to upright triangles otherwise. The `triangular` style
The two triangular heatmap styles and the hexagonal heatmap style can be visualized
as follows. The `dual-triangular` style plots the true values on the upright triangles,
mapping ternary coordinates to upright triangles otherwise. The `triangular` style
maps ternary coordinates to vertices and computes the triangle color based on the
values at the vertices.

Expand Down Expand Up @@ -422,13 +441,6 @@ Please cite as follows:
Marc Harper et al. (2015). python-ternary: Ternary Plots in Python. Zenodo. 10.5281/zenodo.34938
```

# Recent Usage in Publications:

- [Genetic Drift and Selection in Many-Allele Range Expansions](http://biorxiv.org/content/early/2017/06/07/145631) by [Bryan T. Weinstein](https://github.com/btweinstein)
- [Stationary Stability for Evolutionary Dynamics in Finite Populations](http://www.mdpi.com/1099-4300/18/9/316/htm) by Marc Harper and Dashiell Fryer. Entropy 18.9 (2016): 316.
- [pyIAST: Ideal adsorbed solution theory (IAST) Python package](http://www.sciencedirect.com/science/article/pii/S0010465515004403) by [Cory Simon](https://github.com/CorySimon)


# Contributors

- Marc Harper [marcharper](https://github.com/marcharper)
Expand Down

0 comments on commit 26cfbcc

Please sign in to comment.