Google Git
Sign in
chromium / external / github.com / numpy / numpy / refs/tags/v2.1.1 / . / README.md
blob: 51eb0785192d30403d103353d153fe898c226517 [file] [log] [blame] [view]
Motahhar Mokf7b22e132022-04-06 14:03:23[diff] [blame]1<h1 align="center">
Nathan Goldbaume77f9c42023-02-17 20:28:53[diff] [blame]2<img src="https://raw.githubusercontent.com/numpy/numpy/main/branding/logo/primary/numpylogo.svg" width="300">
Motahhar Mokf7b22e132022-04-06 14:03:23[diff] [blame]3</h1><br>
Likhith Chitneni48ea2232017-03-28 06:04:27[diff] [blame]4
Charles Harris193bcff2021-08-24 16:27:49[diff] [blame]5
6[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](
7https://numfocus.org)
Nihaal Sangha5ab126b2022-01-20 16:58:11[diff] [blame]8[![PyPI Downloads](https://img.shields.io/pypi/dm/numpy.svg?label=PyPI%20downloads)](
Charles Harris193bcff2021-08-24 16:27:49[diff] [blame]9https://pypi.org/project/numpy/)
10[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/numpy.svg?label=Conda%20downloads)](
11https://anaconda.org/conda-forge/numpy)
12[![Stack Overflow](https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg)](
13https://stackoverflow.com/questions/tagged/numpy)
Pamphile Roy835dfc02023-06-12 11:45:19[diff] [blame]14[![Nature Paper](https://img.shields.io/badge/DOI-10.1038%2Fs41586--020--2649--2-blue)](
Charles Harris193bcff2021-08-24 16:27:49[diff] [blame]15https://doi.org/10.1038/s41586-020-2649-2)
Even Rouaultabef1d82024-02-24 17:40:24[diff] [blame]16[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/numpy/numpy/badge)](https://securityscorecards.dev/viewer/?uri=github.com/numpy/numpy)
Pedro Nacht2081f292022-11-04 19:58:23[diff] [blame]17
Charles Harris193bcff2021-08-24 16:27:49[diff] [blame]18
Inessa Pawsonb598c4a2022-01-03 02:45:34[diff] [blame]19NumPy is the fundamental package for scientific computing with Python.
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]20
Ralf Gommersd077f602019-05-06 20:36:23[diff] [blame]21- **Website:** https://www.numpy.org
melissawm4a74b462020-05-07 22:18:00[diff] [blame]22- **Documentation:** https://numpy.org/doc
Jarrod Millman5386f8d2017-10-01 01:27:27[diff] [blame]23- **Mailing list:** https://mail.python.org/mailman/listinfo/numpy-discussion
Ralf Gommersd077f602019-05-06 20:36:23[diff] [blame]24- **Source code:** https://github.com/numpy/numpy
Isaiah Norton92c2bc92019-02-26 12:55:06[diff] [blame]25- **Contributing:** https://www.numpy.org/devdocs/dev/index.html
Ralf Gommersd077f602019-05-06 20:36:23[diff] [blame]26- **Bug reports:** https://github.com/numpy/numpy/issues
27- **Report a security vulnerability:** https://tidelift.com/docs/security
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]28
Jarrod Millman5386f8d2017-10-01 01:27:27[diff] [blame]29It provides:
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]30
Jarrod Millman5386f8d2017-10-01 01:27:27[diff] [blame]31- a powerful N-dimensional array object
32- sophisticated (broadcasting) functions
33- tools for integrating C/C++ and Fortran code
34- useful linear algebra, Fourier transform, and random number capabilities
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]35
Charles Harrisf768f3e2018-06-22 13:57:47[diff] [blame]36Testing:
37
Ralf Gommersdfe82452021-12-28 19:49:00[diff] [blame]38NumPy requires `pytest` and `hypothesis`. Tests can then be run after installation with:
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]39
mattipc217f932023-02-22 06:56:52[diff] [blame]40 python -c "import numpy, sys; sys.exit(numpy.test() is False)"
anatoly techtonik13015072015-12-26 10:50:41[diff] [blame]41
Inessa Pawsonb598c4a2022-01-03 02:45:34[diff] [blame]42Code of Conduct
43----------------------
44
Inessa Pawsoncbf44072022-01-04 01:58:47[diff] [blame]45NumPy is a community-driven open source project developed by a diverse group of
Jarrod Millman148f39b2022-01-05 19:57:55[diff] [blame]46[contributors](https://numpy.org/teams/). The NumPy leadership has made a strong
Inessa Pawsonc7ee2e52022-01-03 13:12:24[diff] [blame]47commitment to creating an open, inclusive, and positive community. Please read the
48[NumPy Code of Conduct](https://numpy.org/code-of-conduct/) for guidance on how to interact
49with others in a way that makes our community thrive.
Sebastian Berga066d6b2019-07-14 14:47:31[diff] [blame]50
51Call for Contributions
52----------------------
53
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]54The NumPy project welcomes your expertise and enthusiasm!
55
Inessa Pawson3fd32012022-04-17 21:21:27[diff] [blame]56Small improvements or fixes are always appreciated. If you are considering larger contributions
Eliaz Bobadillaf14f1022021-06-07 21:37:05[diff] [blame]57to the source code, please contact us through the [mailing
58list](https://mail.python.org/mailman/listinfo/numpy-discussion) first.
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]59
Ralf Gommersdfe82452021-12-28 19:49:00[diff] [blame]60Writing code isn’t the only way to contribute to NumPy. You can also:
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]61- review pull requests
Inessa Pawson2dcdb442022-01-04 17:45:21[diff] [blame]62- help us stay on top of new and old issues
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]63- develop tutorials, presentations, and other educational materials
InessaPawson3cd03892021-03-11 08:52:05[diff] [blame]64- maintain and improve [our website](https://github.com/numpy/numpy.org)
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]65- develop graphic design for our brand assets and promotional materials
66- translate website content
InessaPawsond3388142021-03-08 21:30:42[diff] [blame]67- help with outreach and onboard new contributors
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]68- write grant proposals and help with other fundraising efforts
69
Inessa Pawson2dcdb442022-01-04 17:45:21[diff] [blame]70For more information about the ways you can contribute to NumPy, visit [our website](https://numpy.org/contribute/).
InessaPawson0edf1512021-03-08 21:30:17[diff] [blame]71If you’re unsure where to start or how your skills fit in, reach out! You can
72ask on the mailing list or here, on GitHub, by opening a new issue or leaving a
73comment on a relevant issue that is already open.
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]74
InessaPawson0b26d7c2021-03-08 21:32:38[diff] [blame]75Our preferred channels of communication are all public, but if you’d like to
76speak to us in private first, contact our community coordinators at
77numpy-team@googlegroups.com or on Slack (write numpy-team@googlegroups.com for
Scianfe8da1b2021-04-21 13:40:37[diff] [blame]78an invitation).
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]79
InessaPawson1164c122021-03-08 21:31:48[diff] [blame]80We also have a biweekly community call, details of which are announced on the
Ralf Gommersdfe82452021-12-28 19:49:00[diff] [blame]81mailing list. You are very welcome to join.
InessaPawsona7621b12021-03-08 03:50:58[diff] [blame]82
InessaPawson1164c122021-03-08 21:31:48[diff] [blame]83If you are new to contributing to open source, [this
84guide](https://opensource.guide/how-to-contribute/) helps explain why, what,
85and how to successfully get involved.