Skip to content

Commit

Permalink
Merge pull request #119 from stefmolin/conda-install-instructions
Browse files Browse the repository at this point in the history
Add conda installation option.
  • Loading branch information
stefmolin authored May 9, 2023
2 parents 53d4bba + dac2ddd commit 35c3a98
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
<a href="https://pypi.org/project/data-morph-ai/" target="_blank" rel="noopener noreferrer">
<img alt="PyPI release" src="https://img.shields.io/pypi/v/data-morph-ai.svg">
</a>
<a href="https://anaconda.org/conda-forge/data-morph-ai" target="_blank" rel="noopener noreferrer">
<img alt="conda-forge release" src="https://img.shields.io/conda/vn/conda-forge/data-morph-ai.svg">
</a>
<a href="https://pypi.org/project/data-morph-ai/" target="_blank" rel="noopener noreferrer">
<img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/data-morph-ai">
</a>
Expand Down Expand Up @@ -60,16 +63,20 @@ Data Morph transforms an input dataset of 2D points into select shapes, while pr
<br/>
</div>

Read more about the creation of Data Morph [here](https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c).

## Installation

Data Morph can be installed with `pip`:
Data Morph can be installed from PyPI using `pip`:

```console
$ pip install data-morph-ai
```

Alternatively, Data Morph can be installed with `conda` by specifying the `conda-forge` channel:

```console
$ conda install -c conda-forge data-morph-ai
```

## Usage

Once installed, Data Morph can be used on the command line or as an importable Python package. Below are some examples; be sure to check out the [documentation](https://stefmolin.github.io/data-morph) for more information.
Expand Down Expand Up @@ -144,6 +151,8 @@ This code has been altered by Stefanie Molin ([@stefmolin](https://github.com/st

The paper and video can be found on the Autodesk Research website [here](https://www.research.autodesk.com/publications/same-stats-different-graphs-generating-datasets-with-varied-appearance-and-identical-statistics-through-simulated-annealing/). The version of the code placed on GitHub at [jmatejka/same-stats-different-graphs](https://github.com/jmatejka/same-stats-different-graphs), served as the starting point for the Data Morph code base, which is on GitHub at [stefmolin/data-morph](https://github.com/stefmolin/data-morph).

Read more about the creation of Data Morph [here](https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c).

## Citations

If you use this software, please cite both Data Morph (DOI: [10.5281/zenodo.7834197](https://doi.org/10.5281/zenodo.7834197)) and *[Same Stats, Different Graphs: Generating Datasets with Varied Appearance and Identical Statistics through Simulated Annealing](https://damassets.autodesk.net/content/dam/autodesk/research/publications-assets/pdf/same-stats-different-graphs.pdf)* by Justin Matejka and George Fitzmaurice (ACM CHI 2017).
9 changes: 4 additions & 5 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@ Quick Start Guide
Installation
------------
Data Morph can be installed with ``pip``:
Data Morph can be installed from PyPI using ``pip``:

.. code:: console
$ pip install data-morph-ai
..
You can also install with ``conda`` (coming soon):
Alternatively, Data Morph can be installed with ``conda`` by specifying the ``conda-forge`` channel:

.. code:: console
.. code:: console
$ conda install data-morph -c conda-forge
$ conda install -c conda-forge data-morph-ai
.. USAGE INTRO
Expand Down

0 comments on commit 35c3a98

Please sign in to comment.