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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
.. _numpy_docs_mainpage:
###################
NumPy documentation
###################
.. toctree::
:maxdepth: 1
:hidden:
User Guide <user/index>
API reference <reference/index>
Development <dev/index>
release
**Version**: |version|
**Download documentation**:
`Historical versions of documentation <https://numpy.org/doc/>`_
**Useful links**:
`Installation <https://numpy.org/install/>`_ |
`Source Repository <https://github.com/numpy/numpy>`_ |
`Issue Tracker <https://github.com/numpy/numpy/issues>`_ |
`Q&A Support <https://numpy.org/gethelp/>`_ |
`Mailing List <https://mail.python.org/mailman/listinfo/numpy-discussion>`_
NumPy is the fundamental package for scientific computing in Python. It is a
Python library that provides a multidimensional array object, various derived
objects (such as masked arrays and matrices), and an assortment of routines for
fast operations on arrays, including mathematical, logical, shape manipulation,
sorting, selecting, I/O, discrete Fourier transforms, basic linear algebra,
basic statistical operations, random simulation and much more.
.. grid:: 2
.. grid-item-card::
:img-top: ../source/_static/index-images/getting_started.svg
Getting Started
^^^^^^^^^^^^^^^
New to NumPy? Check out the Absolute Beginner's Guide. It contains an
introduction to NumPy's main concepts and links to additional tutorials.
+++
.. button-ref:: user/absolute_beginners
:expand:
:color: secondary
:click-parent:
To the absolute beginner's guide
.. grid-item-card::
:img-top: ../source/_static/index-images/user_guide.svg
User Guide
^^^^^^^^^^
The user guide provides in-depth information on the
key concepts of NumPy with useful background information and explanation.
+++
.. button-ref:: user
:expand:
:color: secondary
:click-parent:
To the user guide
.. grid-item-card::
:img-top: ../source/_static/index-images/api.svg
API Reference
^^^^^^^^^^^^^
The reference guide contains a detailed description of the functions,
modules, and objects included in NumPy. The reference describes how the
methods work and which parameters can be used. It assumes that you have an
understanding of the key concepts.
+++
.. button-ref:: reference
:expand:
:color: secondary
:click-parent:
To the reference guide
.. grid-item-card::
:img-top: ../source/_static/index-images/contributor.svg
Contributor's Guide
^^^^^^^^^^^^^^^^^^^
Want to add to the codebase? Can help add translation or a flowchart to the
documentation? The contributing guidelines will guide you through the
process of improving NumPy.
+++
.. button-ref:: devindex
:expand:
:color: secondary
:click-parent:
To the contributor's guide
.. This is not really the index page, that is found in
_templates/indexcontent.html The toctree content here will be added to the
top of the template header
|
