|
| 1 | +NumPy |
| 2 | +===== |
| 3 | + |
| 4 | +.. toctree:: |
| 5 | + :hidden: |
| 6 | + |
| 7 | + community |
| 8 | + license |
| 9 | + conduct |
| 10 | + old_array_packages |
| 11 | + |
| 12 | + |
| 13 | +NumPy is the fundamental package for scientific computing with Python. |
| 14 | +It contains among other things: |
| 15 | + |
| 16 | +- a powerful N-dimensional array object |
| 17 | +- sophisticated (broadcasting) functions |
| 18 | +- tools for integrating C/C++ and Fortran code |
| 19 | +- useful linear algebra, Fourier transform, and random number capabilities |
| 20 | + |
| 21 | +Besides its obvious scientific uses, NumPy can also be used as an efficient |
| 22 | +multi-dimensional container of generic data. Arbitrary data-types can be |
| 23 | +defined. This allows NumPy to seamlessly and speedily integrate with a wide |
| 24 | +variety of databases. |
| 25 | + |
| 26 | +NumPy is licensed under the :ref:`BSD license <license>`, enabling reuse with |
| 27 | +few restrictions. |
| 28 | + |
| 29 | +Getting Started |
| 30 | +--------------- |
| 31 | + |
| 32 | +To install NumPy, we strongly recommend using a |
| 33 | +*scientific Python distribution*. See |
| 34 | +`Installing the SciPy Stack <https://www.scipy.org/install.html>`__ for |
| 35 | +details. |
| 36 | + |
| 37 | +Many high quality online tutorials, courses, and books are available to get |
| 38 | +started with NumPy. For a quick introduction to NumPy we provide the |
| 39 | +`NumPy Tutorial <https://www.numpy.org/devdocs/user/quickstart.html>`__. We |
| 40 | +also recommend the `SciPy Lecture Notes <https://scipy-lectures.org>`__ for a |
| 41 | +broader introduction to the scientific Python ecosystem. |
| 42 | + |
| 43 | +For more information on the SciPy Stack (for which NumPy provides the |
| 44 | +fundamental array data structure), see `scipy.org <https://www.scipy.org/>`__. |
| 45 | + |
| 46 | +Documentation |
| 47 | +------------- |
| 48 | + |
| 49 | +The most up-to-date NumPy documentation can be found at |
| 50 | +`Latest (development) version <https://www.numpy.org/devdocs>`__. |
| 51 | +It includes a user guide, full reference documentation, a developer guide, meta |
| 52 | +information, and "NumPy Enhancement Proposals" (which include the NumPy Roadmap |
| 53 | +and detailed plans for major new features). |
| 54 | + |
| 55 | +A complete archive of documentation for all NumPy releases (minor versions; bug |
| 56 | +fix releases don't contain significant documentation changes) since 2009 can be |
| 57 | +found at https://docs.scipy.org. |
| 58 | + |
| 59 | +Support NumPy |
| 60 | +------------- |
| 61 | + |
| 62 | +If you have found NumPy to be useful in your work, research or company, please |
| 63 | +consider making a donation to the project commensurate with your resources. Any |
| 64 | +amount helps! All donations will be used strictly to fund the development of |
| 65 | +NumPy’s open source software, documentation and community. |
| 66 | + |
| 67 | +Donations are managed by the NumFOCUS Foundation, which is the legal and fiscal |
| 68 | +umbrella for the project. NumFOCUS is a 501(c)3 non-profit foundation, so if |
| 69 | +you are subject to US Tax law, your contribution is tax-deductible. |
| 70 | +NumPy's `Steering Council <https://www.numpy.org/devdocs/dev/governance/index.html>`__ |
| 71 | +will make the decisions on how to best use any funds received. Technical and |
| 72 | +infrastructure priorities are documented on the |
| 73 | +`NumPy Roadmap <https://www.numpy.org/neps/roadmap.html>`__. |
| 74 | + |
| 75 | +.. raw:: html |
| 76 | + |
| 77 | + <div> |
| 78 | + <ul class="thumbnails"> |
| 79 | + |
| 80 | + <li class="span4"> |
| 81 | + <div class="pull-left img"> |
| 82 | + <a href="https://numfocus.org/sponsored-projects"> |
| 83 | + <img alt="NumFOCUS" src="_static/NumFOCUS_sponsored_project.png" width="180"> |
| 84 | + </a> |
| 85 | + </div> |
| 86 | + </li> |
| 87 | + |
| 88 | + |
| 89 | + <li class="span4"> |
| 90 | + <div style="padding-top:2px; padding-bottom:2px; text-align:center; margin:0px auto;"> |
| 91 | + <div style="display: inline-block; float:left; margin-left:1em;"> |
| 92 | + <a href="https://numfocus.salsalabs.org/donate-to-numpy" target="_blank" |
| 93 | + style="background:#FFA500;padding:10px;margin:1px 0px; |
| 94 | + text-decoration:none;font-size:12pt;color:#222222; |
| 95 | + font-family:Arial,Helvetica,sans-serif;display:inline-block;"> |
| 96 | + Donate Now! |
| 97 | + </a> |
| 98 | + </div> |
| 99 | + </div> |
| 100 | + </li> |
| 101 | + |
| 102 | + </ul> |
| 103 | + </div> |
| 104 | + |
| 105 | + |
| 106 | +Institutional Partners |
| 107 | +~~~~~~~~~~~~~~~~~~~~~~ |
| 108 | + |
| 109 | +Institutional Partners are organizations that support the project by employing |
| 110 | +NumPy contributors, with contributing to the project as part of their official |
| 111 | +duties. Current Institutional Partners include: |
| 112 | + |
| 113 | +.. raw:: html |
| 114 | + |
| 115 | + <div> |
| 116 | + <ul class="thumbnails"> |
| 117 | + |
| 118 | + <li class="span4"> |
| 119 | + <div class="pull-left img"> |
| 120 | + <a href="https://www.berkeley.edu/"> |
| 121 | + <img alt="Berkeley" src="_static/berkeley-color.svg" width="180"> |
| 122 | + </a> |
| 123 | + </div> |
| 124 | + </li> |
| 125 | + |
| 126 | + <li class="span4"> |
| 127 | + <div class="pull-left img"> |
| 128 | + <a href="https://quansight.com"> |
| 129 | + <img alt="Quansight" src="_static/quansight.svg" width="180"> |
| 130 | + </a> |
| 131 | + </div> |
| 132 | + </li> |
| 133 | + |
| 134 | + </ul> |
| 135 | + </div> |
| 136 | + |
| 137 | + |
| 138 | +Sponsors |
| 139 | +~~~~~~~~ |
| 140 | + |
| 141 | +NumPy receives direct funding from the following sources: |
| 142 | + |
| 143 | + |
| 144 | +.. raw:: html |
| 145 | + |
| 146 | + <div> |
| 147 | + <ul class="thumbnails"> |
| 148 | + |
| 149 | + <li class="span4"> |
| 150 | + <div class="pull-left img"> |
| 151 | + <a href="https://www.moore.org/"> |
| 152 | + <img alt="Gordon and Betty Moore Foundation" src="_static/moore.svg" width="180"> |
| 153 | + </a> |
| 154 | + </div> |
| 155 | + </li> |
| 156 | + |
| 157 | + <li class="span4"> |
| 158 | + <div class="pull-left img"> |
| 159 | + <a href="https://www.sloan.org/"> |
| 160 | + <img alt="Alfred P. Sloan Foundation" src="_static/sloan.svg" width="180"> |
| 161 | + </a> |
| 162 | + </div> |
| 163 | + </li> |
| 164 | + |
| 165 | + <li class="span4"> |
| 166 | + <div class="pull-left img"> |
| 167 | + <a href="https://tidelift.com/subscription/pkg/pypi-numpy?utm_source=pypi-numpy&utm_medium=referral&utm_campaign=website"> |
| 168 | + <img alt="Tidelift" src="_static/Tidelift_Logos_RGB_Tidelift_Mark_On-White.png" width="180"> |
| 169 | + </a> |
| 170 | + </div> |
| 171 | + </li> |
| 172 | + |
| 173 | + </ul> |
| 174 | + </div> |
| 175 | + |
0 commit comments