netwulf


Namenetwulf JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/benmaier/netwulf
SummaryInteractively visualize networks with Ulf Aslak's d3-tool from Python.
upload_time2020-06-30 15:04:53
maintainer
docs_urlNone
authorUlf Aslak, Benjamin F. Maier
requires_python~=3.5
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |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
-----

|DOI|

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

Install
-------

.. code:: bash

   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

.. code:: python

   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 <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|

Dev notes
---------

Clone and install this repository as

.. code:: bash

   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 <https://github.com/ulfaslak/network_styling_with_d3>`__. If this
repository is updated, change to ``/netwulf/js/``, then do

.. code:: 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``

.. code:: bash

   make readme

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

.. code:: bash

   make pypi

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

.. code:: bash

   make upload

.. |logo| image:: https://github.com/benmaier/netwulf/raw/master/img/logo_small.png
.. |example| image:: https://github.com/benmaier/netwulf/raw/master/img/simple_example.gif
.. |DOI| image:: https://joss.theoj.org/papers/10.21105/joss.01425/status.svg
   :target: https://doi.org/10.21105/joss.01425
.. |Documentation Status| image:: https://readthedocs.org/projects/netwulf/badge/?version=latest
   :target: https://netwulf.readthedocs.io/en/latest/?badge=latest
.. |visualization example0| image:: https://github.com/benmaier/netwulf/raw/master/img/BA_1.png
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg
   :target: code-of-conduct.md
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/benmaier/netwulf",
    "name": "netwulf",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "~=3.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ulf Aslak, Benjamin F. Maier",
    "author_email": "bfmaier@physik.hu-berlin.de",
    "download_url": "https://files.pythonhosted.org/packages/5c/9f/95a4ce4071f44e9c73ed2c944f72393510bdaf79c5e417268a82c6187e36/netwulf-0.1.5.tar.gz",
    "platform": "",
    "description": "|logo|\n\nAbout\n-----\n\n**Simple and interactive network visualization in Python.** Network\nvisualization is an indispensable tool for exploring and communicating\npatterns in complex systems. Netwulf offers an ultra-simple API for\n**reproducible interactive visualization** of networks directly from a\nPython prompt or Jupyter notebook. As a research tool, its purpose is to\nallow hassle-free quick interactive layouting/styling for communication\npurposes.\n\nThe package is build around the philosophy that network manipulation and\npreprocessing should be done programmatically, but that the efficient\ngeneration of a visually appealing network is best done interactively,\nwithout code.\n\n|example|\n\nPaper\n-----\n\n|DOI|\n\nIf you use ``netwulf`` for your scientific work, consider citing us!\nWe're `published in JOSS <https://doi.org/10.21105/joss.01425>`__.\n\nInstall\n-------\n\n.. code:: bash\n\n   pip install netwulf\n\n``netwulf`` was developed and tested for\n\n-  Python 3.5\n-  Python 3.6\n-  Python 3.7\n\nSo far, the package's functionality was tested on Mac OS X, several\nLinux distributions and Windows NT. Windows support cannot be guaranteed\nas we do not have constant access to machines with this OS.\n\nDependencies\n------------\n\n``netwulf`` directly depends on the following packages which will be\ninstalled by ``pip`` during the installation process\n\n-  ``networkx>=2.0``\n-  ``numpy>=0.14``\n-  ``matplotlib>=3.0``\n-  ``simplejson>=3.0``\n\nDocumentation\n-------------\n\n|Documentation Status|\n\nThe full documentation is available at https://netwulf.rtfd.io.\n\nExample\n-------\n\nCreate a network and look at it\n\n.. code:: python\n\n   import networkx as nx\n   from netwulf import visualize\n\n   G = nx.barabasi_albert_graph(100,m=1)\n   visualize(G)\n\n|visualization example0|\n\nChangelog\n---------\n\nChanges are logged in a `separate\nfile <https://github.com/benmaier/netwulf/blob/master/CHANGELOG.md>`__.\n\nLicense\n-------\n\nThis project is licensed under the `MIT\nLicense <https://github.com/benmaier/netwulf/blob/master/LICENSE>`__.\n\nContributing\n------------\n\nIf you want to contribute to this project, please make sure to read the\n`code of\nconduct <https://github.com/benmaier/netwulf/blob/master/CODE_OF_CONDUCT.md>`__\nand the `contributing\nguidelines <https://github.com/benmaier/netwulf/blob/master/CONTRIBUTING.md>`__.\nIn case you're wondering about what to contribute, we're always\ncollecting ideas of what we want to implement next in the `outlook\nnotes <https://github.com/benmaier/netwulf/blob/master/OUTLOOK.md>`__.\n\n|Contributor Covenant|\n\nDev notes\n---------\n\nClone and install this repository as\n\n.. code:: bash\n\n   git clone --recurse-submodules -j8 git@github.com:benmaier/netwulf.git\n   make\n\nNote that ``make`` per default lets ``pip`` install a development\nversion of the repository.\n\nThe JS base code in ``/netwulf/js/`` is a fork of `Ulf Aslak's\ninteractive web\napp <https://github.com/ulfaslak/network_styling_with_d3>`__. If this\nrepository is updated, change to ``/netwulf/js/``, then do\n\n.. code:: bash\n\n   git fetch upstream\n   git merge upstream/master\n   git commit -m \"merged\"\n   git push\n\nIf you want to upload to PyPI, first convert the new ``README.md`` to\n``README.rst``\n\n.. code:: bash\n\n   make readme\n\nIt will give you warnings about bad ``.rst``-syntax. Fix those errors in\n``README.rst``. Then wrap the whole thing\n\n.. code:: bash\n\n   make pypi\n\nIt will probably give you more warnings about ``.rst``-syntax. Fix those\nuntil the warnings disappear. Then do\n\n.. code:: bash\n\n   make upload\n\n.. |logo| image:: https://github.com/benmaier/netwulf/raw/master/img/logo_small.png\n.. |example| image:: https://github.com/benmaier/netwulf/raw/master/img/simple_example.gif\n.. |DOI| image:: https://joss.theoj.org/papers/10.21105/joss.01425/status.svg\n   :target: https://doi.org/10.21105/joss.01425\n.. |Documentation Status| image:: https://readthedocs.org/projects/netwulf/badge/?version=latest\n   :target: https://netwulf.readthedocs.io/en/latest/?badge=latest\n.. |visualization example0| image:: https://github.com/benmaier/netwulf/raw/master/img/BA_1.png\n.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg\n   :target: code-of-conduct.md",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Interactively visualize networks with Ulf Aslak's d3-tool from Python.",
    "version": "0.1.5",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9d0a9c031ff0c4fdb28e650644b52906",
                "sha256": "8a18a5afbd2fa430a1dc1d4bd07a9369009ebae121de1e58953dcd426aed05bb"
            },
            "downloads": -1,
            "filename": "netwulf-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "9d0a9c031ff0c4fdb28e650644b52906",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.5",
            "size": 236034,
            "upload_time": "2020-06-30T15:04:53",
            "upload_time_iso_8601": "2020-06-30T15:04:53.759884Z",
            "url": "https://files.pythonhosted.org/packages/5c/9f/95a4ce4071f44e9c73ed2c944f72393510bdaf79c5e417268a82c6187e36/netwulf-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-06-30 15:04:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "benmaier",
    "error": "Could not fetch GitHub repository",
    "lcname": "netwulf"
}
        
Elapsed time: 0.11915s