Skip to content

Commit

Permalink
clarify statement, close #24
Browse files Browse the repository at this point in the history
  • Loading branch information
benmaier committed May 15, 2019
1 parent 8d67c8e commit 4e054d7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)

![logo](https://github.com/benmaier/netwulf/raw/master/img/logo_small.png)

## About

**Simple and interactive network visualization in Python.** Network visualization is an indispensable tool for exploring and communicating patterns in complex systems. Netwulf offers an ultra-simple API for **reproducible interactive visualization** of networks directly from a Python prompt or Jupyter notebook. As a research tool, its purpose is to allow hassle-free quick exploration of networks, and enable interactive layouting and styling for communication purposes.
**Simple and interactive network visualization in Python.** Network visualization is an indispensable tool for exploring and communicating patterns in complex systems. Netwulf offers an ultra-simple API for **reproducible interactive visualization** of networks directly from a Python prompt or Jupyter notebook. As a research tool, its purpose is to allow hassle-free quick interactive layouting/styling for communication purposes.

The package is build around the philosophy that network manipulation and preprocessing should be done programmatically, but that the efficient generation of a visually appealing network is best done interactively, without code.

![example](https://github.com/benmaier/netwulf/raw/master/img/simple_example.gif)

Expand Down Expand Up @@ -54,6 +54,8 @@ Changes are logged in a [separate file](https://github.com/benmaier/netwulf/blob

If you want to contribute to this project, please make sure to read the [code of conduct](https://github.com/benmaier/netwulf/blob/master/CODE_OF_CONDUCT.md) and the [contributing guidelines](https://github.com/benmaier/netwulf/blob/master/CONTRIBUTING.md).

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)

## Dev notes

The JS base code in `/netwulf/js/` is a fork of [Ulf Aslak's interactive web app](https://github.com/ulfaslak/network_styling_with_d3). If this repository is updated, change to `/netwulf/js/`, then do
Expand Down
5 changes: 4 additions & 1 deletion docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ About this project
==================

Netwulf is an interactive visualization tool for networkx_ Graph-objects,
that allows you to produce beautiful looking network visualizations. Simply
that allows you to produce beautifully looking network visualizations. Simply
input a `networkx.Graph` object, style the network in the interactive console
and either download the result as a PNG or pipe the layout back to Python for
further processing. Netwulf is fast and relies on no crude dependencies.
It is build around the philosophy that network manipulation and preprocessing
should be done programmatically, but that the efficient generation of a visually
appealing network is best done interactively, without code.

Quick example
-------------
Expand Down

0 comments on commit 4e054d7

Please sign in to comment.