README.rst 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .. image:: https://raw.githubusercontent.com/scipy/scipy/main/doc/source/_static/logo.svg
  2. :target: https://scipy.org
  3. :width: 110
  4. :height: 110
  5. :align: left
  6. .. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
  7. :target: https://numfocus.org
  8. .. image:: https://img.shields.io/pypi/dm/scipy.svg?label=Pypi%20downloads
  9. :target: https://pypi.org/project/scipy/
  10. .. image:: https://img.shields.io/conda/dn/conda-forge/scipy.svg?label=Conda%20downloads
  11. :target: https://anaconda.org/conda-forge/scipy
  12. .. image:: https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg
  13. :target: https://stackoverflow.com/questions/tagged/scipy
  14. .. image:: https://img.shields.io/badge/DOI-10.1038%2Fs41592--019--0686--2-blue
  15. :target: https://www.nature.com/articles/s41592-019-0686-2
  16. SciPy (pronounced "Sigh Pie") is an open-source software for mathematics,
  17. science, and engineering. It includes modules for statistics, optimization,
  18. integration, linear algebra, Fourier transforms, signal and image processing,
  19. ODE solvers, and more.
  20. - **Website:** https://scipy.org
  21. - **Documentation:** https://docs.scipy.org/doc/scipy/
  22. - **Development version of the documentation:** https://scipy.github.io/devdocs
  23. - **Mailing list:** https://mail.python.org/mailman3/lists/scipy-dev.python.org/
  24. - **Source code:** https://github.com/scipy/scipy
  25. - **Contributing:** https://scipy.github.io/devdocs/dev/index.html
  26. - **Bug reports:** https://github.com/scipy/scipy/issues
  27. - **Code of Conduct:** https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html
  28. - **Report a security vulnerability:** https://tidelift.com/docs/security
  29. - **Citing in your work:** https://www.scipy.org/citing-scipy/
  30. SciPy is built to work with
  31. NumPy arrays, and provides many user-friendly and efficient numerical routines,
  32. such as routines for numerical integration and optimization. Together, they
  33. run on all popular operating systems, are quick to install, and are free of
  34. charge. NumPy and SciPy are easy to use, but powerful enough to be depended
  35. upon by some of the world's leading scientists and engineers. If you need to
  36. manipulate numbers on a computer and display or publish the results, give
  37. SciPy a try!
  38. For the installation instructions, see `our install
  39. guide <https://scipy.org/install/>`__.
  40. Call for Contributions
  41. ----------------------
  42. We appreciate and welcome contributions. Small improvements or fixes are always appreciated; issues labeled as "good
  43. first issue" may be a good starting point. Have a look at `our contributing
  44. guide <https://scipy.github.io/devdocs/dev/index.html>`__.
  45. Writing code isn’t the only way to contribute to SciPy. You can also:
  46. - review pull requests
  47. - triage issues
  48. - develop tutorials, presentations, and other educational materials
  49. - maintain and improve `our website <https://github.com/scipy/scipy.org>`__
  50. - develop graphic design for our brand assets and promotional materials
  51. - help with outreach and onboard new contributors
  52. - write grant proposals and help with other fundraising efforts
  53. If you’re unsure where to start or how your skills fit in, reach out! You can
  54. ask on the mailing list or here, on GitHub, by leaving a
  55. comment on a relevant issue that is already open.
  56. If you are new to contributing to open source, `this
  57. guide <https://opensource.guide/how-to-contribute/>`__ helps explain why, what,
  58. and how to get involved.