Skip to content
Interactive visualization of networks based on Ulf Aslak's d3 web app.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs fixed some gubs in docs Jun 18, 2019
img refined README May 15, 2019
netwulf (a) merged js with master; (b) convert numpy types to python types be… Jun 21, 2019
paper adding dois May 5, 2019
sandbox refined testing May 17, 2019
.gitattributes
.gitignore moved tests May 16, 2019
.gitmodules started to fill in some stuff Oct 15, 2018
.readthedocs.yml do not clone submodules Mar 27, 2019
.travis.yml try xvfb May 16, 2019
CHANGELOG.md
CODE_OF_CONDUCT.md added code of conduct, see #17 May 15, 2019
CONTRIBUTING.md refined testing May 17, 2019
LICENSE updated copyright May 15, 2019
MANIFEST.in added readme.rst Oct 17, 2018
Makefile fixed test path May 17, 2019
OUTLOOK.md added outlook to keep track of what we want to work at in the future May 23, 2019
README.md fixed bug May 24, 2019
README.rst fixed bug May 24, 2019
pytest.ini include tests in package and update readme with dev notes May 17, 2019
requirements.txt
setup.cfg testing init May 16, 2019
setup.py

README.md

logo

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

Paper

status

If you use netwulf for your scientific work, consider citing us! We're currently under review in JOSS.

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

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

Example

Create a network and look at it

import networkx as nx
from netwulf import visualize

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

visualization example0

Changelog

Changes are logged in a separate file.

License

This project is licensed under the MIT License.

Contributing

If you want to contribute to this project, please make sure to read the code of conduct and the contributing guidelines. 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.

Contributor Covenant

Dev notes

Clone and install this repository as

git clone --recurse-submodules -j8 git@github.com: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. If this repository is updated, change to /netwulf/js/, then do

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

make readme

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

make pypi

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

make upload
You can’t perform that action at this time.