diff options
Diffstat (limited to 'reference/readwrite/text.html')
| -rw-r--r-- | reference/readwrite/text.html | 609 |
1 files changed, 609 insertions, 0 deletions
diff --git a/reference/readwrite/text.html b/reference/readwrite/text.html new file mode 100644 index 00000000..aa0cb088 --- /dev/null +++ b/reference/readwrite/text.html @@ -0,0 +1,609 @@ + +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + + <title>Network Text — NetworkX 3.1rc1.dev0 documentation</title> + + + + <script data-cfasync="false"> + document.documentElement.dataset.mode = localStorage.getItem("mode") || "light"; + document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; + </script> + + <!-- Loaded before other Sphinx assets --> + <link href="../../_static/styles/theme.css?digest=796348d33e8b1d947c94" rel="stylesheet"> +<link href="../../_static/styles/bootstrap.css?digest=796348d33e8b1d947c94" rel="stylesheet"> +<link href="../../_static/styles/pydata-sphinx-theme.css?digest=796348d33e8b1d947c94" rel="stylesheet"> + + + <link href="../../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=796348d33e8b1d947c94" rel="stylesheet"> + <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2"> +<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2"> +<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2"> + + <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../_static/custom.css" /> + <link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" /> + <link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" /> + <link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" /> + <link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" /> + + <!-- Pre-loaded scripts that we'll load fully later --> + <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94"> +<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94"> + + <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script> + <script src="../../_static/doctools.js"></script> + <script src="../../_static/sphinx_highlight.js"></script> + <script src="../../_static/copybutton.js"></script> + <script>DOCUMENTATION_OPTIONS.pagename = 'reference/readwrite/text';</script> + <link rel="canonical" href="https://networkx.org/documentation/stable/reference/readwrite/text.html" /> + <link rel="search" type="application/opensearchdescription+xml" + title="Search within NetworkX 3.1rc1.dev0 documentation" + href="../../_static/opensearch.xml"/> + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="next" title="generate_network_text" href="generated/networkx.readwrite.text.generate_network_text.html" /> + <link rel="prev" title="Matrix Market" href="matrix_market.html" /> +<script + defer + data-domain="networkx.org" + src="https://views.scientific-python.org/js/script.js" +></script> + + <meta name="viewport" content="width=device-width, initial-scale=1" /> + <meta name="docsearch:language" content="en"> + </head> + + + <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="light"> + + + + <a class="skip-link" href="#main-content">Skip to main content</a> +<div class="container-fluid version-alert devbar"> + <div class="row no-gutters"> + <div class="col-12 text-center"> + This page is documentation for a DEVELOPMENT / PRE-RELEASE version. + <a + class="btn version-stable font-weight-bold ml-3 my-3 align-baseline" + href="https://networkx.org/documentation/stable/" + >Switch to stable version</a + > + </div> + </div> +</div> + + + + <input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary"> + <label class="overlay overlay-primary" for="__primary"></label> + + + <input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary"> + <label class="overlay overlay-secondary" for="__secondary"></label> + + + <div class="search-button__wrapper"> + <div class="search-button__overlay"></div> + <div class="search-button__search-container"> + +<form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> + <i class="fa-solid fa-magnifying-glass"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"> + <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> +</form> + </div> + </div><div class="bd-header-announcement container-fluid" id="header-announcement"> + + + +<div class="bd-header-announcement__content"><p><a href='https://forms.gle/NUGcBxyjx5onbAgc8'> NetworkX User Survey 2023</a> 🎉 Fill out the survey to tell us about your ideas, complaints, praises of NetworkX!</p></div> + + </div> + + + <nav class="bd-header navbar navbar-expand-lg bd-navbar" id="navbar-main"><div class="bd-header__inner bd-page-width"> + <label class="sidebar-toggle primary-toggle" for="__primary"> + <span class="fa-solid fa-bars"></span> + </label> + <div id="navbar-start"> + + + + + +<a class="navbar-brand logo" href="../../index.html"> + + + + + + + + + + + <img src="../../_static/networkx_banner.svg" class="logo__image only-light" alt="Logo image"> + <img src="../../_static/networkx_banner.svg" class="logo__image only-dark" alt="Logo image"> + + +</a> + + </div> + + + <div class="col-lg-9 navbar-header-items"> + <div id="navbar-center" class="mr-auto"> + + <div class="navbar-center-item"> + <nav class="navbar-nav"> + <p class="sidebar-header-items__title" role="heading" aria-level="1" aria-label="Site Navigation"> + Site Navigation + </p> + <ul id="navbar-main-elements" class="navbar-nav"> + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../install.html"> + Install + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../tutorial.html"> + Tutorial + </a> + </li> + + + <li class="nav-item current active"> + <a class="nav-link nav-internal" href="../index.html"> + Reference + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../auto_examples/index.html"> + Gallery + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../developer/index.html"> + Developer + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../release/index.html"> + Releases + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-external" href="https://networkx.org/nx-guides/"> + Guides + </a> + </li> + + </ul> +</nav> + </div> + + </div> + + <div id="navbar-end"> + + <div class="navbar-end-item navbar-persistent--container"> + +<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip"> + <i class="fa-solid fa-magnifying-glass"></i> +</button> + </div> + + + <div class="navbar-end-item"> + <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip"> + <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span> + <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span> + <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span> +</button> + </div> + + <div class="navbar-end-item"> + <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links"> + <li class="nav-item"> + + + + + + + + <a href="https://networkx.org" title="Home Page" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fas fa-home"></i></span> + <label class="sr-only">Home Page</label></a> + </li> + <li class="nav-item"> + + + + + + + + <a href="https://github.com/networkx/networkx" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-github-square"></i></span> + <label class="sr-only">GitHub</label></a> + </li> + </ul> + </div> + + <div class="navbar-end-item"> + <ul class="navbar-nav"> + <li class="mr-2 dropdown"> + <button + type="button" + class="btn btn-version btn-sm navbar-btn dropdown-toggle" + id="dLabelMore" + data-toggle="dropdown" + > + v3.1rc1.dev0 + <span class="caret"></span> + </button> + <ul class="dropdown-menu" aria-labelledby="dLabelMore"> + <li> + <a href="https://networkx.org/documentation/latest/index.html" + >devel (latest)</a + > + </li> + <li> + <a href="https://networkx.org/documentation/stable/index.html" + >current (stable)</a + > + </li> + </ul> + </li> +</ul> + </div> + + </div> + </div> + + + + + <div class="navbar-persistent--mobile"> +<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip"> + <i class="fa-solid fa-magnifying-glass"></i> +</button> + </div> + + + + <label class="sidebar-toggle secondary-toggle" for="__secondary"> + <span class="fa-solid fa-outdent"></span> + </label> + + +</div> + </nav> + + + <div class="bd-container"> + <div class="bd-container__inner bd-page-width"> + + <div class="bd-sidebar-primary bd-sidebar"> + + + <div class="sidebar-header-items sidebar-primary__section"> + + + <div class="sidebar-header-items__center"> + + <div class="navbar-center-item"> + <nav class="navbar-nav"> + <p class="sidebar-header-items__title" role="heading" aria-level="1" aria-label="Site Navigation"> + Site Navigation + </p> + <ul id="navbar-main-elements" class="navbar-nav"> + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../install.html"> + Install + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../tutorial.html"> + Tutorial + </a> + </li> + + + <li class="nav-item current active"> + <a class="nav-link nav-internal" href="../index.html"> + Reference + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../auto_examples/index.html"> + Gallery + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../developer/index.html"> + Developer + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-internal" href="../../release/index.html"> + Releases + </a> + </li> + + + <li class="nav-item"> + <a class="nav-link nav-external" href="https://networkx.org/nx-guides/"> + Guides + </a> + </li> + + </ul> +</nav> + </div> + + </div> + + + + + <div class="sidebar-header-items__end"> + + <div class="navbar-end-item"> + <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip"> + <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span> + <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span> + <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span> +</button> + </div> + + <div class="navbar-end-item"> + <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links"> + <li class="nav-item"> + + + + + + + + <a href="https://networkx.org" title="Home Page" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fas fa-home"></i></span> + <label class="sr-only">Home Page</label></a> + </li> + <li class="nav-item"> + + + + + + + + <a href="https://github.com/networkx/networkx" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-github-square"></i></span> + <label class="sr-only">GitHub</label></a> + </li> + </ul> + </div> + + <div class="navbar-end-item"> + <ul class="navbar-nav"> + <li class="mr-2 dropdown"> + <button + type="button" + class="btn btn-version btn-sm navbar-btn dropdown-toggle" + id="dLabelMore" + data-toggle="dropdown" + > + v3.1rc1.dev0 + <span class="caret"></span> + </button> + <ul class="dropdown-menu" aria-labelledby="dLabelMore"> + <li> + <a href="https://networkx.org/documentation/latest/index.html" + >devel (latest)</a + > + </li> + <li> + <a href="https://networkx.org/documentation/stable/index.html" + >current (stable)</a + > + </li> + </ul> + </li> +</ul> + </div> + + </div> + + </div> + + + <div class="sidebar-start-items sidebar-primary__section"> + <div class="sidebar-start-items__item"><nav class="bd-links" id="bd-docs-nav" aria-label="Section navigation"> + <p class="bd-links__title" role="heading" aria-level="1"> + Section Navigation + </p> + <div class="bd-toc-item navbar-nav"> + <ul class="current nav bd-sidenav"> +<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li> +<li class="toctree-l1"><a class="reference internal" href="../classes/index.html">Graph types</a></li> +<li class="toctree-l1"><a class="reference internal" href="../algorithms/index.html">Algorithms</a></li> +<li class="toctree-l1"><a class="reference internal" href="../functions.html">Functions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../generators.html">Graph generators</a></li> +<li class="toctree-l1"><a class="reference internal" href="../linalg.html">Linear algebra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../convert.html">Converting to and from other data formats</a></li> +<li class="toctree-l1"><a class="reference internal" href="../relabel.html">Relabeling nodes</a></li> +<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Reading and writing graphs</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="adjlist.html">Adjacency List</a></li> +<li class="toctree-l2"><a class="reference internal" href="multiline_adjlist.html">Multiline Adjacency List</a></li> +<li class="toctree-l2"><a class="reference internal" href="edgelist.html">Edge List</a></li> +<li class="toctree-l2"><a class="reference internal" href="gexf.html">GEXF</a></li> +<li class="toctree-l2"><a class="reference internal" href="gml.html">GML</a></li> +<li class="toctree-l2"><a class="reference internal" href="graphml.html">GraphML</a></li> +<li class="toctree-l2"><a class="reference internal" href="json_graph.html">JSON</a></li> +<li class="toctree-l2"><a class="reference internal" href="leda.html">LEDA</a></li> +<li class="toctree-l2"><a class="reference internal" href="sparsegraph6.html">SparseGraph6</a></li> +<li class="toctree-l2"><a class="reference internal" href="pajek.html">Pajek</a></li> +<li class="toctree-l2"><a class="reference internal" href="matrix_market.html">Matrix Market</a></li> +<li class="toctree-l2 current active"><a class="current reference internal" href="#">Network Text</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../drawing.html">Drawing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../randomness.html">Randomness</a></li> +<li class="toctree-l1"><a class="reference internal" href="../exceptions.html">Exceptions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../utils.html">Utilities</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +</ul> + + </div> +</nav> + </div> + <div class="sidebar-start-items__item"> + </div> + </div> + + + + <div class="sidebar-end-items sidebar-primary__section"> + <div class="sidebar-end-items__item"> + </div> + </div> + + + <div id="rtd-footer-container"></div> + + </div> + <main id="main-content" class="bd-main"> + + + <div class="bd-content"> + <div class="bd-article-container"> + + <div class="bd-header-article"> + + </div> + + + <article class="bd-article" role="main"> + + <section id="module-networkx.readwrite.text"> +<span id="network-text"></span><h1>Network Text<a class="headerlink" href="#module-networkx.readwrite.text" title="Permalink to this heading">#</a></h1> +<p>Text-based visual representations of graphs</p> +<table class="autosummary longtable table autosummary"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="generated/networkx.readwrite.text.generate_network_text.html#networkx.readwrite.text.generate_network_text" title="networkx.readwrite.text.generate_network_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generate_network_text</span></code></a>(graph[, with_labels, ...])</p></td> +<td><p>Generate lines in the "network text" format</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="generated/networkx.readwrite.text.write_network_text.html#networkx.readwrite.text.write_network_text" title="networkx.readwrite.text.write_network_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">write_network_text</span></code></a>(graph[, path, ...])</p></td> +<td><p>Creates a nice text representation of a graph</p></td> +</tr> +</tbody> +</table> +</section> + + + </article> + + + + </div> + + + + <div class="bd-sidebar-secondary bd-toc"> + +<div class="toc-item"> + +<form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> + <i class="fa-solid fa-magnifying-glass"></i> + <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"> + <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> +</form> +</div> + +<div class="toc-item"> + +</div> + + </div> + + + </div> + <footer class="bd-footer-content"> + <div class="bd-footer-content__inner"> + + </div> + </footer> + + </main> + </div> + </div> + + + + <!-- Scripts loaded after <body> so the DOM is not blocked --> + <script src="../../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94"></script> +<script src="../../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94"></script> + + <footer class="bd-footer"><div class="bd-footer__inner container"> + + <div class="footer-item"> + +<p class="copyright"> + + © Copyright 2004-2023, NetworkX Developers.<br> + +</p> + + </div> + + <div class="footer-item"> + <p class="theme-version"> + Built with the + <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html"> + PyData Sphinx Theme + </a> + 0.12.0. +</p> + </div> + + <div class="footer-item"> + +<p class="sphinx-version"> +Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br> +</p> + + </div> + +</div> + </footer> + </body> +</html>
\ No newline at end of file |