This documents the development version of NetworkX. Documentation for the current release can be found here.
NetworkX requires Python 3.7, 3.8, or 3.9. If you do not already have a Python environment configured on your computer, please see the instructions for installing the full scientific Python stack.
Below we assume you have the default Python environment already configured on
your computer and you intend to install
networkx inside of it. If you want
to create and work with Python virtual environments, please follow instructions
on venv and virtual
First, make sure you have the latest version of
pip (the Python package manager)
installed. If you do not, refer to the Pip documentation and install
Install the released version¶
Install the current release of
$ pip install networkx
To upgrade to a newer release use the
$ pip install --upgrade networkx
If you do not have permission to install software systemwide, you can
install into your user directory using the
$ pip install --user networkx
$ pip install .
Install the development version¶
If you have Git installed on your system, it is also
possible to install the development version of
Before installing the development version, you may need to uninstall the
standard version of
$ pip uninstall networkx
$ git clone https://github.com/networkx/networkx.git $ cd networkx $ pip install -e .
pip install -e . command allows you to follow the development branch as
it changes by creating links in the right places and installing the command
line scripts to the appropriate locations.
Then, if you want to update
networkx at any time, in the same directory do:
$ git pull
Some optional packages (e.g.,
gdal) may require compiling
C or C++ code. If you have difficulty installing these packages
pip, please consult the homepages of those packages.
The following extra packages provide additional functionality. See the
files in the
requirements/ directory for information about specific
PyYAML provides YAML format reading and writing.
gdal provides shapefile format reading and writing.
lxml used for GraphML XML format.
networkx and extra packages, do:
$ pip install networkx[extra]
To explicitly install all optional packages, do:
$ pip install pygraphviz pydot pyyaml gdal lxml
Or, install any optional package (e.g.,
$ pip install pygraphviz
NetworkX uses the Python
pytest testing package. You can learn more
about pytest on their homepage.
Test a source distribution¶
You can test the complete package from the unpacked source directory with:
Test an installed package¶
From a shell command prompt you can test the installed package with:
pytest --pyargs networkx
If you have a file-based (not a Python egg) installation you can test the installed package with:
>>> import networkx as nx >>> nx.test()
python -c "import networkx as nx; nx.test()"
Run NetworkX tests.
- verbosity: integer, optional
Level of detail in test reports. Higher numbers provide more detail.
- doctest: bool, optional
True to run doctests in code modules