{ "__type": "IngestedDoc", "__tag": 4010, "_content": {}, "_ordered_sections": [], "item_file": null, "item_line": null, "item_type": null, "aliases": [], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": null, "references": null, "qa": "reference:index", "arbitrary": [ { "__type": "Section", "__tag": 4015, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.cluster", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:cluster" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.constants", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:constants" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.datasets", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:datasets" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.differentiate", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:differentiate" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:fft" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.fftpack", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:fftpack" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.integrate", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:integrate" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.interpolate", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:interpolate" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.io", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:io" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.linalg", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:linalg" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.ndimage", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:ndimage" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.optimize", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:optimize" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:signal" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.sparse", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:sparse" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.spatial", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:spatial" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.special", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:special" }, "kind": "exists" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "scipy.stats", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:stats" }, "kind": "exists" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "SciPy's functionality is organized into " }, { "__type": "CrossRef", "__tag": 4002, "value": "submodules", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": ", whereas the " }, { "__type": "CrossRef", "__tag": 4002, "value": "main namespace", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "scipy" }, { "__type": "Text", "__tag": 4046, "value": ") only has a few utility functions. In SciPy, most functions and classes are self-contained and are straightforward to use, e.g.:" } ] }, { "__type": "Code", "__tag": 4050, "value": ">>> from scipy.constants import speed_of_light\n>>> from scipy.signal.windows import hann\n...\n>>> print(f\"{speed_of_light} m/s is quite fast.\")\n299792458.0 m/s is quite fast.\n>>> hann(7, sym=True) # 7 sample symmetric Hann window\narray([0. , 0.25, 0.75, 1. , 0.75, 0.25, 0. ])", "execution_status": null, "out": "" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The remainder of this page contains the list of " }, { "__type": "CrossRef", "__tag": 4002, "value": "submodules", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": ", followed by the content of the " }, { "__type": "CrossRef", "__tag": 4002, "value": "main namespace", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": ". The " }, { "__type": "CrossRef", "__tag": 4002, "value": "design conventions for SciPy submodules", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:api-dev:design_conventions_modules" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " are part of the " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy-development", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "API Reference" } ], "level": 0, "target": "scipy-api" }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The public submodules have the following structure:" } ] }, { "__type": "Code", "__tag": 4050, "value": "+---+---+-------------------------------------------------------------------+\n| :ref:`scipy ` Main namespace |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.cluster` Clustering algorithms |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.cluster.hierarchy` Hierarchical clustering |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.cluster.vq` K-means clustering and vector quantization |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.constants` Physical and mathematical constants |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.datasets` Datasets |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.differentiate` Finite Difference Differentiation |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.fft` Discrete Fourier transforms |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.fftpack` Legacy discrete Fourier transforms |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.integrate` Integration and ODEs |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.interpolate` Interpolation |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.io` Input and output |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.io.arff` ARFF files |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.io.matlab` MATLAB® files |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.io.wavfile` WAV sound files |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.linalg` Linear algebra |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.linalg.blas` Low-level BLAS functions |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.linalg.cython_blas` BLAS Functions for Cython |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.linalg.interpolative` Interpolative matrix decomposition |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.linalg.lapack` Low-level LAPACK functions |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.linalg.cython_lapack` LAPACK functions for Cython |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.ndimage` Multidimensional image processing |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.optimize` Optimization and root finding |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.optimize.cython_optimize` Cython optimize root finding API |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.optimize.elementwise` Elementwise Scalar Optimization |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.signal` Signal processing |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.signal.windows` Window functions |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.sparse` Sparse linear algebra |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.sparse.csgraph` Compressed sparse graph routines |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.sparse.linalg` Sparse linear algebra |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.spatial` Spatial algorithms and data structures |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.spatial.distance` Distance computations |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.spatial.transform` Spatial Transformations |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.special` Special functions |\n+---+---+-------------------------------------------------------------------+\n| | `scipy.stats` Statistical functions |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.stats.contingency` Contingency table functions |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.stats.mstats` Statistical functions for masked arrays |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.stats.qmc` Quasi-Monte Carlo submodule |\n+---+---+-------------------------------------------------------------------+\n| | | `scipy.stats.sampling` Random Number Generators |\n+---+---+-------------------------------------------------------------------+", "execution_status": null, "out": "" } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Submodules" } ], "level": 1, "target": "submodule_list" }, { "__type": "Section", "__tag": 4015, "children": [], "title": [ { "__type": "Text", "__tag": 4046, "value": "Main namespace (" }, { "__type": "InlineCode", "__tag": 4051, "value": "scipy" }, { "__type": "Text", "__tag": 4046, "value": ")" } ], "level": 1, "target": "main_namespace" } ], "local_refs": [] }