File: api.rst

package info (click to toggle)
spaghetti 1.7.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 30,412 kB
  • sloc: python: 2,301; makefile: 40
file content (40 lines) | stat: -rw-r--r-- 665 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. _api_ref:

.. currentmodule:: spaghetti

API reference
=============

.. _network_api:


Network feature instantiation
-----------------------------

.. autosummary::
   :toctree: generated/

    spaghetti.Network
    spaghetti.PointPattern


Network feature extraction and creation
---------------------------------------

.. autosummary::
   :toctree: generated/

    spaghetti.extract_component
    spaghetti.spanning_tree
    spaghetti.element_as_gdf
    spaghetti.regular_lattice


Save and load a network
-----------------------

.. autosummary::
   :toctree: generated/

    spaghetti.network.Network.savenetwork
    spaghetti.network.Network.loadnetwork