deploy: networkit/networkit-website@792966f

_sources/contact.rst.txt

@@ -0,0 +1,16 @@
+=======
+Contact
+=======
+
+.. |mailinglist| image:: resources/mailinglist.png
+
+Questions and feedback regarding NetworKit should be addressed to the NetworKit mailing list |mailinglist|. We encourage all users to `register <https://sympa.cms.hu-berlin.de/sympa/subscribe/networkit>`_ for the mailing list.
+
+NetworKit is maintained by the `Modeling and Analysis of Complex Systems <https://www.informatik.hu-berlin.de/de/forschung/gebiete/macsy>`_
+group of the Department of Computer Science
+at `Humboldt Universität zu Berlin <https://www.hu-berlin.de/en/>`_.
+
+Visit the website of Humboldt Universtität zu Berlin for the
+`imprint <https://www.hu-berlin.de/en/hu-en/imprint/>`_ and
+`data protection statement <https://www.hu-berlin.de/de/hu/impressum/datenschutzerklaerung>`_.
+

_sources/credits.rst.txt

@@ -0,0 +1,116 @@
+.. role:: hidden
+   :class: hidden
+
+=====================
+Credits & References
+=====================
+
+:hidden:`HiddenBiggerHeadingFont`
+---------------------------------
+
+History
+~~~~~~~
+
+NetworKit is maintained by the `Research Group Modeling and Analysis of Complex Systems <https://www.informatik.hu-berlin.de/de/forschung/gebiete/macsy>`_ of the Institute of Computer Science at the `Humboldt-University of Berlin <https://www.hu-berlin.de/de>`_.
+It was seeded by the project `Parallel analysis of dynamic networks -- Algorithm engineering of efficient combinatorial and numerical methods <http://parco.iti.kit.edu/forschung-en.shtml>`_, for which we acknowledge
+financial support by MWK Baden-Württemberg. In this project Henning Meyerhenke was the principal investigator and Christian L. Staudt was the main PhD student. Since NetworKit's start in 2013, it has grown well
+beyond the original MWK project and our group, with contributors and users from all over the world.
+
+Maintainers
+~~~~~~~~~~~
+
+- Eugenio Angriman
+- Fabian Brandt-Tumescheit
+- Henning Meyerhenke
+
+Past Maintainers
+~~~~~~~~~~~~~~~~
+
+- Elisabetta Bergamini
+- Kolja Esders
+- Alexander van der Grinten
+- Christian L. Staudt
+- Maximilian Vogel
+
+Contributors
+~~~~~~~~~~~~
+
+- Klaus Ahrens
+- Thijs Baaijen
+- Roman Bange
+- Lukas Barth
+- Miriam Beddig
+- Stefan Bertsch
+- Pratistha Bhattarai
+- Andreas Bilke
+- Simon Bischof
+- Guido Brückner
+- Johann Charfreitag
+- Daniel Darabos
+- Stephan Druskat
+- Mark Erb
+- Philipp Fischbeck
+- Patrick Flick
+- John Gelhausen
+- Lars Gottesbüren 
+- Jeff Green
+- David Grinberg
+- Michael Hamann
+- Lukas Hartmann
+- Ali Haydari
+- Till Hoffmann
+- Daniel Hoske
+- Yani Kolev
+- Alexander Leonhardt
+- Marten Lienen
+- Gerd Lindner
+- Moritz v. Looz
+- Sarah Lutteropp
+- Yassine Marrakchi
+- Marc Nemes
+- Franz-Benjamin Mocnik
+- Charmaine Nyambura Ndolo
+- Chien-Chun Ni
+- F. Nguyen
+- Mustafa Özdayi
+- Manuel Penschuck
+- Lucas Archimedes Gregorio Henr Petersen
+- Marvin Pogoda
+- Marcel Radermacher
+- Klara Reichard
+- Matteo Riondato
+- Marvin Ritter
+- Aleksejs Sazonovs
+- Arie Slobbe
+- Jonas Spinner
+- Jonathan Striebel 
+- Hung Tran
+- Florian Weber
+- Deklan Webster
+- Michael Wegner
+- Jörg Weisbarth
+- David Weiss
+
+License
+~~~~~~~
+
+The source code of this program is released under the `MIT License <http://opensource.org/licenses/MIT>`_.  We ask you to cite us if you use this code in your project (c.f. the publications section below and especially the `technical report <https://arxiv.org/abs/1403.3005>`_). Feedback is also welcome.
+
+External Code
+~~~~~~~~~~~~~
+
+The program source includes:
+
+- the `The Lean Mean C++ Option Parser <http://optionparser.sourceforge.net>`_ by Matthias S. Benkmann
+- the `TTMath <http://optionparser.sourceforge.net>`_ bignum library by Tomasz Sowa
+
+Data sets
+~~~~~~~~~
+
+Here are some data sets, which are often used for benchmarking algorithms in NetworKit.
+
+- `10th DIMACS Implementation Challenge (2010-2012) <http://www.cc.gatech.edu/dimacs10/downloads.shtml>`_
+
+- `Stanford Network Analysis Project <http://snap.stanford.edu/>`_
+
+- `The Koblenz Network Collection <http://konect.uni-koblenz.de/>`_

_sources/datasets.rst.txt

@@ -0,0 +1,11 @@
+=========
+Data sets
+=========
+
+On this page, we provide links to data sets which can be used with NetworKit.
+
+- `10th DIMACS Implementation Challenge (2010-2012) <http://www.cc.gatech.edu/dimacs10/downloads.shtml>`_
+
+- `Stanford Network Analysis Project <http://snap.stanford.edu/>`_
+
+- `The Koblenz Network Collection <http://konect.uni-koblenz.de/>`_

_sources/get_started.rst.txt

@@ -0,0 +1,239 @@
+.. |separator| raw:: html
+
+	<div style="padding-top: 25px; border-bottom: 1px solid #d4d7d9;"></div>
+
+.. _get_started:
+
+===========
+Get Started
+===========
+
+Take a look at `Installation`_ or `Build NetworKit from Source`_ in order to install NetworKit as a Python3 package or directly build it from source.
+
+With NetworKit as a Python extension module, you get access to native high-performance code and can at the same time work interactively in the Python ecosystem.
+Although the standard Python interpreter works fine, we recommend `IPython <http://ipython.readthedocs.org/en/stable/>`_ as a great environment for scientific
+workflows. View the `IPython Quickstart Guide`_ for installation instructions and how to use NetworKit with IPython.
+
+Once you have installed NetworKit, please make sure to check out our
+`NetworKit UserGuide <https://github.com/networkit/networkit/blob/master/notebooks/User-Guide.ipynb>`_ for an overview of the features provided
+in NetworKit.
+
+|separator|
+
+.. _Installation:
+
+Installation
+============
+
+.. _Installation Requirements:
+
+Requirements
+------------
+
+You will need the following software to install NetworKit as a python package:
+
+- A modern C++ compiler, e.g.: `g++ <https://gcc.gnu.org>`_ (>= 7.0) or `clang++ <http://clang.llvm.org>`_ (>= 5.0)
+- OpenMP for parallelism (usually ships with the compiler)
+- Python3 (3.7 or higher is supported)
+
+  - Development libraries for Python3. The package name depends on your distribution. Examples:
+
+    - Debian/Ubuntu: :code:`apt-get install python3-dev`
+    - RHEL/CentOS: :code:`dnf install python3-devel`
+- `Pip <https://pypi.python.org/pypi/pip>`_
+- `CMake <https://cmake.org/>`_ version 3.5 or higher (e.g., :code:`pip3 install cmake`)
+- Build System: `Make <https://www.gnu.org/software/make/>`_ or `Ninja <https://ninja-build.org/>`_
+- Cython version 0.29 or higher (e.g., :code:`pip3 install cython`)
+
+.. _Linux:
+
+Linux
+-----
+
+There are several ways to install NetworKit. Besides using :code:`pip3` (the common Python module way), it is also possible to get it via package manager channels like :code:`conda`, :code:`spack` and :code:`brew`. The complete list of possibilities is available on `Github <https://github.com/networkit/networkit>`_ .
+The following example uses :code:`pip3` for installation on a recent Debian/Ubuntu-based distribution. Asume you have a clean minimal system, you will first have to install all requirements: 
+
+.. code-block:: bash
+
+  # On Ubuntu or equivalent, python3 is pre-installed.
+
+  # Install compilation tools (includes compiler, OpenMP)
+  sudo apt install build-essential
+
+  # Install Python3, pip3
+  sudo apt install python3-dev python3-pip
+
+  # Install cmake, cython
+  pip3 install cmake cython
+
+  # And finally ... install NetworKit
+  pip3 install networkit
+
+.. _macOS:
+
+macOS
+-----
+
+For macOS you can follow similar steps as shown for :code:`pip3` under Linux. However we recommend using :code:`brew` for managing NetworKit installations.
+Apart from the compilation environment all other dependencies are handled by the brew formula.
+
+.. code-block:: bash
+
+  # Install xcode command line tools
+  xcode-select --install
+
+  # Install Homebrew (if needed)
+  ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+  # Install NetworKit via brew
+  brew install libomp
+
+.. _Windows:
+
+Windows
+-------
+
+With the release of NetworKit 9.0 we have an experimental support for Windows installations. While installation is also possible via :code:`pip`, requirements include the official `Python package <https://www.python.org/downloads/windows/>`_ and at least the free Community-Edition of `Visual Studio <https://visualstudio.microsoft.com/de/downloads/>`_.
+
+You also have to make sure that MSVC-compiler (:code:`cl.exe`) can be found during installation. One possible way to achieve this is to call :code:`pip` from within the "Native Tools Command Prompt" provided by Visual Studio.
+
+.. code-block:: bash
+
+  # Requirements: Official Python release is installed and cl.exe can be found. 
+  # If "Native Tools Command Prompt" is used, cmake and ninja are already installed.
+
+  # Install cython
+  pip3 install cython
+
+  # And finally ... install NetworKit
+  pip3 install networkit
+
+.. _Windows 10:
+
+Windows 10
+^^^^^^^^^^
+
+For Windows 10, it is also possible to use the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ See the official documentation on how to activate the Linux Subsystem. 
+
+The Linux Subsystem is fully compatible with NetworKit. After a successful installation, simply **open a new command line** and start a new bash shell. From there you can follow the instructions for Linux.
+
+|separator|
+
+.. _Build NetworKit from Source:
+
+Build NetworKit from Source
+===========================
+
+You can clone NetworKit from `GitHub <https://github.com/networkit/networkit>`_ with git.
+
+For further information, we refer to the `README file <https://github.com/networkit/networkit#installation-instructions>`_ of our GitHub repository, which contains instructions for building NetworKit from source.
+
+|separator|
+
+.. _IPython Quickstart Guide:
+
+Use NetworKit with IPython
+==========================
+
+First make sure you have installed IPython, e.g. via pip: :code:`pip3 install ipython`.
+
+IPython Terminal
+----------------
+
+If you want to use NetworKit in the IPython terminal, type the following commands in your OS terminal:
+
+.. code-block:: bash
+
+	ipython3
+
+.. code-block:: python
+
+	from networkit import *
+
+The first line opens the IPython terminal. The second line imports the *networkit* Python module. After that, you should be able to use NetworKit interactively.
+For usage examples, refer to the `NetworKit UserGuide <https://github.com/networkit/networkit/blob/master/notebooks/User-Guide.ipynb>`_.
+
+IPython Notebook/Jupyter
+------------------------
+
+Additionally, we recommend that you familiarize yourself with NetworKit through experimenting with the interactive IPython Notebook `NetworKit_UserGuide.ipynb` located
+in the folder `Doc/Notebooks`. The user guide also introduces a large portion of NetworKits functionality with usage examples. To display and work with these notebooks,
+you have to install jupyter and start a local notebook server from the terminal with:
+
+.. code-block:: bash
+
+	jupyter/ipython3 notebook
+
+If you run into any problems with jupyter, head over to the `jupyter documentation <http://jupyter.readthedocs.io/en/latest/install.html>`_. If the notebook server starts as it is supposed to, your default browser should open a web interface or you have to open it manually. Then you can add `NetworKit_UserGuide.ipynb` from the above mentioned location or browse to the location through the web interface.
+
+To show plots within the notebooks, place the following two lines at the beginning of your notebook:
+
+.. code-block:: python
+
+	%matplotlib inline
+	import matplotlib.pyplot as plt
+
+**Note:** Instead of running jupyter, it may still be possible to run :code:`ipython3 notebook`. However, the notebook functionality of the ipython package is deprecated and has been moved to jupyter, which we strongly recommend.
+
+NetworKit Usage Example
+=======================
+
+Now that you are done installing NetworKit, you might want to try the following example:
+
+.. code-block:: python
+
+	>>> from networkit import *
+	>>> g = generators.HyperbolicGenerator(1e5).generate()
+	>>> overview(g)
+	Network Properties for:		G#5
+	nodes, edges			100000, 300036
+	directed?			False
+	weighted?			False
+	isolated nodes			1815
+	self-loops			0
+	density				0.000060
+	clustering coefficient		0.720003
+	min/max/avg degree		0, 1174, 6.000720
+	degree assortativity		0.001383
+	number of connected components	4026
+	size of largest component	78387 (78.39 %)
+
+	>>> communities = community.detectCommunities(g, inspect=True)
+	PLM(balanced,pc,turbo) detected communities in 0.14902853965759277 [s]
+	solution properties:
+	-------------------  -----------
+	# communities        4253
+	min community size      1
+	max community size   1821
+	avg. community size    23.5128
+	modularity              0.987991
+	-------------------  -----------
+
+	>>>
+
+|separator|
+
+Known Issues
+============
+
+- Mac OS X 10.10 "Yosemite": Some users have reported compilation problems on Yosemite with g++ 4.9. The compiler errors mention register problems.
+  While the exact reason remains unclear, the actual issue seems to be that the compiler tries to perform a dual architecture build.
+  Fix: Enforce a 64-bit build by prepending :code:`ARCHFLAGS="-arch x86_64"` to your setup/pip command, e.g. as in
+  :code:`sudo ARCHFLAGS="-arch x86_64" python3 setup.py build_ext --inplace -j4` or :code:`sudo ARCHFLAGS="-arch x86_64" pip3 install networkit`.
+
+-	NetworKit has not yet been successfully built on **Windows 8 and below** in a reproducible way. This is partially due to the fact that Windows ships without a C++ compiler which is
+	necessary to build	the Python extensions. Even with the Visual C++ Redistributable our attempts were not successful. Any help is appreciated. It may
+	be possible to build NetworKit as a library on Windows in environments like MinGW or Cygwin.
+
+-	Some algorithms (e.g. StronglyConnectedComponents) are implemented in a recursive manner and for large input may exceed the default stack size on your platform.
+	To work around this issue, you can lift the stack size limit for your terminal process and subsequent child processes with :code:`ulimit -s unlimited` or :code:`ulimit -Hs` (to the hard limit if there is one). It is also possible to change resource limits from Python directly with :code:`import resource; resource.setrlimit(resource.RLIMIT_STACK, (-1, -1))`.
+-	On macOS, it can happen that the g++ compiler is unable to locate specific Linux-based header files. An example would be an error during the compilation of a C++ header which includes :code:`stdint`. This can generate the following error message: :code:`fatal error: sys/_types/_int8_t.h: No such file or directory`. This error will most likely happen on new systems or after a major system upgrade. In this case you need to (again) install the Xcode command line tools: :code:`xcode-select --install`. Afterwards the code should compile completely.
+
+
+|separator|
+
+Contributions
+=============
+
+We would like to encourage contributions to the NetworKit source code. See the `NetworKit Development Guide <https://networkit.github.io/dev-docs/DevGuide.html#devGuide>`_ for instructions. For support
+please contact the `mailing list <https://sympa.cms.hu-berlin.de/sympa/subscribe/networkit>`_.