| # <a href="https://numpy.org/"><img alt="NumPy" src="/branding/logo/primary/numpylogo.svg" height="60"></a> |
| |
| <!--[](--> |
| <!--https://dev.azure.com/numpy/numpy/_build/latest?definitionId=1?branchName=main)--> |
| <!--[](--> |
| <!--https://github.com/numpy/numpy/actions/workflows/build_test.yml)--> |
| <!--[](--> |
| <!--https://app.travis-ci.com/numpy/numpy)--> |
| <!--[](--> |
| <!--https://circleci.com/gh/numpy/numpy)--> |
| <!--[](--> |
| <!--https://codecov.io/gh/numpy/numpy)--> |
| |
| []( |
| https://numfocus.org) |
| []( |
| https://pypi.org/project/numpy/) |
| []( |
| https://anaconda.org/conda-forge/numpy) |
| []( |
| https://stackoverflow.com/questions/tagged/numpy) |
| []( |
| https://doi.org/10.1038/s41586-020-2649-2) |
| |
| NumPy is the fundamental package needed for scientific computing with Python. |
| |
| - **Website:** https://www.numpy.org |
| - **Documentation:** https://numpy.org/doc |
| - **Mailing list:** https://mail.python.org/mailman/listinfo/numpy-discussion |
| - **Source code:** https://github.com/numpy/numpy |
| - **Contributing:** https://www.numpy.org/devdocs/dev/index.html |
| - **Bug reports:** https://github.com/numpy/numpy/issues |
| - **Report a security vulnerability:** https://tidelift.com/docs/security |
| |
| It provides: |
| |
| - a powerful N-dimensional array object |
| - sophisticated (broadcasting) functions |
| - tools for integrating C/C++ and Fortran code |
| - useful linear algebra, Fourier transform, and random number capabilities |
| |
| Testing: |
| |
| NumPy requires `pytest`. Tests can then be run after installation with: |
| |
| python -c 'import numpy; numpy.test()' |
| |
| |
| Call for Contributions |
| ---------------------- |
| |
| The NumPy project welcomes your expertise and enthusiasm! |
| |
| Small improvements or fixes are always appreciated; issues labeled as ["good |
| first issue"](https://github.com/numpy/numpy/labels/good%20first%20issue) |
| may be a good starting point. If you are considering larger contributions |
| to the source code, please contact us through the [mailing |
| list](https://mail.python.org/mailman/listinfo/numpy-discussion) first. |
| |
| Writing code isn’t the only way to contribute to NumPy. You can also: |
| - review pull requests |
| - triage issues |
| - develop tutorials, presentations, and other educational materials |
| - maintain and improve [our website](https://github.com/numpy/numpy.org) |
| - develop graphic design for our brand assets and promotional materials |
| - translate website content |
| - help with outreach and onboard new contributors |
| - write grant proposals and help with other fundraising efforts |
| |
| If you’re unsure where to start or how your skills fit in, reach out! You can |
| ask on the mailing list or here, on GitHub, by opening a new issue or leaving a |
| comment on a relevant issue that is already open. |
| |
| Our preferred channels of communication are all public, but if you’d like to |
| speak to us in private first, contact our community coordinators at |
| numpy-team@googlegroups.com or on Slack (write numpy-team@googlegroups.com for |
| an invitation). |
| |
| We also have a biweekly community call, details of which are announced on the |
| mailing list. You are very welcome to join. |
| |
| If you are new to contributing to open source, [this |
| guide](https://opensource.guide/how-to-contribute/) helps explain why, what, |
| and how to successfully get involved. |
