Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #56 from OrkoHunter/final-docs
Browse files Browse the repository at this point in the history
Remove redundant information from documentation
  • Loading branch information
ysitu committed Aug 18, 2015
2 parents 82e4f50 + 55e696e commit 8a6b683
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 19 deletions.
7 changes: 5 additions & 2 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ You can install from source by downloading a source archive file
(tar.gz or zip) or by checking out the source files from the
git source code repository.

NetworkX-METIS needs a compiler to build the C library of METIS. For Linux/Mac OS, gcc
should be installed and for Windows OS, `mingw32 <http://www.mingw.org/>`_ must be installed.
Installation on Windows is largely the same as on Linux/Mac except that
no "platform compiler" is pre-installed. So, an extra ``--compiler`` flag
may be necessary to specify a compiler. A simple guide for installing
and setting up the compiler is available
`here <https://github.com/cython/cython/wiki/CythonExtensionsOnWindows>`_.

Source archive file
-------------------
Expand Down
19 changes: 2 additions & 17 deletions doc/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,14 @@ Overview

NetworkX-METIS is an add-on for the `NetworkX`_ python package using `METIS`_ for graph partitioning.

NetworkX is a Python package for the creation, manipulation and study of the structure, dynamics, and functions of complex networkx. METIS is a C library written for partitioning graphs, partitioning finite element meshes, and producing fill reducing orderings for sparse matrices. NetworkX-METIS uses Cython to wrap the METIS library to make it available in Python.

Who uses NetworkX-METIS?
------------------------

Goals
-----

The Python programming language
-------------------------------

Python is a powerful programming language that allows simple and flexible representations of networks, and clear and concise expressions of network algorithms (and other algorithms too). Python has a vibrant and growing ecosystem of packages that NetworkX uses to provide more features such as numerical linear algebra and drawing. In addition
Python is also an excellent "glue" language for putting together pieces of software from other languages which allows reuse of legacy code and engineering of high-performance algorithms [Langtangen04]_.

Equally important, Python is free, well-supported, and a joy to use.

In order to make the most out of NetworkX-METIS you will want to know how to write basic programs in Python. Among the many guides to Python, we recommend the documentation at
http://www.python.org and the text by Alex Martelli [Martelli03]_.

Free software
-------------

NetworkX-METIS is free software; you can redistribute it and/or
modify it under the terms of the :doc:`Apache License </reference/legal>`.
modify it under the terms of the :doc:`Apache License </reference/legal>`_.
We welcome contributions from the community. Information on
NetworkX development is found at the NetworkX Developer Zone at Github
https://github.com/networkx/networkx-metis
Expand Down

0 comments on commit 8a6b683

Please sign in to comment.