Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/benmaier/netwulf

Interactive visualization of networks based on Ulf Aslak's d3 web app.
https://github.com/benmaier/netwulf

d3 network-visualization networkx python

Last synced: 2 months ago
JSON representation

Interactive visualization of networks based on Ulf Aslak's d3 web app.

Host: GitHub
URL: https://github.com/benmaier/netwulf
Owner: benmaier
License: mit
Created: 2018-10-15T13:02:34.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-28T05:04:25.000Z (over 1 year ago)
Last Synced: 2024-03-01T05:03:42.667Z (4 months ago)
Topics: d3, network-visualization, networkx, python
Language: Python
Homepage:
Size: 82.3 MB
Stars: 282
Watchers: 9
Forks: 25
Open Issues: 17
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Lists

awesome-stars - netwulf
awesome-starred - benmaier/netwulf - Interactive visualization of networks based on Ulf Aslak's d3 web app. (python)

README

![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 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)

## Paper

[![DOI](https://joss.theoj.org/papers/10.21105/joss.01425/status.svg)](https://doi.org/10.21105/joss.01425)

If you use `netwulf` for your scientific work, consider citing us! We're [published in JOSS](https://doi.org/10.21105/joss.01425).

## Install

pip install netwulf

`netwulf` was developed and tested for

* Python 3.5
* Python 3.6
* Python 3.7

So far, the package's functionality was tested on Mac OS X, several Linux distributions and Windows NT. Windows support cannot be guaranteed as we do not have constant access to machines with this OS.

## Dependencies

`netwulf` directly depends on the following packages which will be installed by `pip` during the installation process

* `networkx>=2.0`
* `numpy>=0.14`
* `matplotlib>=3.0`
* `simplejson>=3.0`

## Documentation

[![Documentation Status](https://readthedocs.org/projects/netwulf/badge/?version=latest)](https://netwulf.readthedocs.io/en/latest/?badge=latest)

The full documentation is available at https://netwulf.rtfd.io.

## Example

Create a network and look at it

```python
import networkx as nx
from netwulf import visualize

G = nx.barabasi_albert_graph(100,m=1)
visualize(G)
```

![visualization example0](https://github.com/benmaier/netwulf/raw/master/img/BA_1.png)

## Changelog

Changes are logged in a [separate file](https://github.com/benmaier/netwulf/blob/master/CHANGELOG.md).

## License

This project is licensed under the [MIT License](https://github.com/benmaier/netwulf/blob/master/LICENSE).

## Contributing

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). In case you're wondering about what to contribute, we're always collecting ideas of what we want to implement next in the [outlook notes](https://github.com/benmaier/netwulf/blob/master/OUTLOOK.md).

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

## Dev notes

Clone and install this repository as

```bash
git clone --recurse-submodules -j8 [email protected]:benmaier/netwulf.git
make
```

Note that `make` per default lets `pip` install a development version of the repository.

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

```bash
git fetch upstream
git merge upstream/master
git commit -m "merged"
git push
```

If you want to upload to PyPI, first convert the new `README.md` to `README.rst`

```bash
make readme
```

It will give you warnings about bad `.rst`-syntax. Fix those errors in `README.rst`. Then wrap the whole thing

```bash
make pypi
```

It will probably give you more warnings about `.rst`-syntax. Fix those until the warnings disappear. Then do

```bash
make upload
```