.. _numpy_docs_mainpage:

###################
NumPy documentation
###################

.. toctree::
   :maxdepth: 1
   :hidden:

   User Guide <user/index>
   API reference <reference/index>
   Development <dev/index>


**Version**: |version|

**Download documentation**:
`PDF Version <https://numpy.org/doc/stable/numpy-user.pdf>`_ |
`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.

.. panels::
    :card: + intro-card text-center
    :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 p-2

    ---
    :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.

    .. link-button:: user/absolute_beginners
        :type: ref
        :text: 
        :classes: stretched-link
    
    ---
    :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.

    .. link-button:: user
        :type: ref
        :text: 
        :classes: stretched-link

    ---
    :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.

    .. link-button:: reference
        :type: ref
        :text: 
        :classes: stretched-link 

    ---
    :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.

    .. link-button:: devindex
        :type: ref
        :text: 
        :classes: stretched-link

.. 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
