'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'numpydoc',
+ 'sphinx_panels',
'scipyoptdoc',
'doi_role',
'matplotlib.sphinxext.plot_directive',
r"OpenSSL\.rand is deprecated", # OpenSSL package in linkcheck
r"distutils Version", # distutils
r"the imp module is deprecated", # invoke (via pooch)
+ r"open_text is deprecated", # sphinx_panels
):
warnings.filterwarnings( # deal with other modules having bad imports
'ignore', message=".*" + key, category=DeprecationWarning)
You can skip these steps if you are using ``conda``, as these dependencies
will be installed automatically.
-.. tab-set::
+.. note::
- .. tab-item:: Linux
+ Linux
If you want to use the system Python and ``pip``, you will need:
`ATLAS <http://math-atlas.sourceforge.net/>`__ and
`MKL <https://software.intel.com/en-us/intel-mkl>`__.
- .. tab-set::
+ .. note::
- .. tab-item:: Debian/Ubuntu Linux
+ Debian/Ubuntu Linux
.. note::
See also :ref:`ubuntu-guide`.
- .. tab-item:: Fedora
+ Fedora
To install SciPy build requirements, you can do::
advantage that new dependencies or updates to required versions are
handled by the package managers.
- .. tab-item:: CentOS/RHEL
+ CentOS/RHEL
To install SciPy build requirements, you can do::
advantage that new dependencies or updates to required versions are
handled by the package managers.
- .. tab-item:: Arch
+ Arch
To install SciPy build requirements, you can do::
If you are using conda, these dependencies can be installed in the conda
environment itself. See :ref:`conda-guide` for more details.
- .. tab-item:: OSX
+ OSX
Install Apple Developer Tools. An easy way to do this is to
`open a terminal window <https://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line>`_,
`git <https://git-scm.com/>`_, the software we need to download and manage the
SciPy source code. See also :ref:`build-osx`.
- .. tab-item:: Windows
+ Windows
See :ref:`build-windows`.
Next, set up your development environment.
-.. tab-set::
+.. note::
- .. tab-item:: conda
+ conda
With ``conda`` installed (through
`Miniforge or Mambaforge <https://github.com/conda-forge/miniforge>`_,
Your command prompt now lists the name of your new environment, like so
``(scipy-dev)$``.
- .. tab-item:: pip+venv
+ pip+venv
**With** :ref:`system-level dependencies <system-level>` **installed**, execute
the following commands at the terminal from the base directory of your
Installation
------------
-.. grid:: 2
+.. panels::
+ :card: + install-card
+ :column: col-lg-6 col-md-6 col-sm-12 col-xs-12 p-3
- .. grid-item-card::
+ Working with conda?
+ ^^^^^^^^^^^^^^^^^^^
- Working with conda?
- ^^^^^^^^^^^^^^^^^^^
+ SciPy is part of the `Anaconda <https://docs.continuum.io/anaconda/>`__
+ distribution and can be installed with Anaconda or Miniconda:
- SciPy is part of the `Anaconda <https://docs.continuum.io/anaconda/>`__
- distribution and can be installed with Anaconda or Miniconda:
+ ++++++++++++++++++++++
- ++++++++++++++++++++++
+ .. code-block:: bash
- .. code-block:: bash
+ conda install scipy
- conda install scipy
+ ---
- .. grid-item-card::
+ Prefer pip?
+ ^^^^^^^^^^^
- Prefer pip?
- ^^^^^^^^^^^
+ SciPy can be installed via pip from `PyPI <https://pypi.org/project/scipy>`__.
- SciPy can be installed via pip from `PyPI <https://pypi.org/project/scipy>`__.
+ ++++
- ++++
+ .. code-block:: bash
- .. code-block:: bash
+ pip install scipy
- pip install scipy
+ ---
+ :column: col-12 p-3
- .. grid-item-card::
- :columns: 12
+ In-depth instructions?
+ ^^^^^^^^^^^^^^^^^^^^^^
- In-depth instructions?
- ^^^^^^^^^^^^^^^^^^^^^^
+ Installing a specific version? Installing from source? Check the advanced
+ installation page.
- Installing a specific version? Installing from source? Check the
- installation page.
+ .. container:: custom-button
- .. container:: custom-button
+ :ref:`Learn more <installing-upgrading>`
- `Learn more <https://scipy.org/install/>`__
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ install_upgrade
Tutorials
---------
**SciPy** (pronounced "Sigh Pie") is an open-source software for mathematics,
science, and engineering.
-.. grid:: 2
+.. panels::
+ :card: + intro-card text-center
+ :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex
- .. grid-item-card::
- :img-top: _static/index_getting_started.png
+ ---
+ :img-top: _static/index_getting_started.png
- Getting started
- ^^^^^^^^^^^^^^^
+ Getting started
+ ^^^^^^^^^^^^^^^
- New to *SciPy*? Check out the getting started guides. They contain an
- introduction to *SciPy's* main concepts and links to additional tutorials.
+ New to *SciPy*? Check out the getting started guides. They contain an
+ introduction to *SciPy'* main concepts and links to additional tutorials.
- +++
+ +++
- .. button-ref:: getting_started_ref
- :expand:
- :color: secondary
- :click-parent:
+ .. link-button:: getting_started_ref
+ :type: ref
+ :text: To the getting started guides
+ :classes: btn-block btn-secondary stretched-link
- To the getting started guides
+ ---
+ :img-top: _static/index_user_guide.png
- .. grid-item-card::
- :img-top: _static/index_user_guide.png
+ User guide
+ ^^^^^^^^^^
- User guide
- ^^^^^^^^^^
+ The user guide provides in-depth information on the
+ key concepts of SciPy with useful background information and explanation.
- The user guide provides in-depth information on the
- key concepts of SciPy with useful background information and explanation.
+ +++
- +++
+ .. link-button:: user_guide
+ :type: ref
+ :text: To the user guide
+ :classes: btn-block btn-secondary stretched-link
- .. button-ref:: user_guide
- :expand:
- :color: secondary
- :click-parent:
+ ---
+ :img-top: _static/index_api.png
- To the user guide
+ API reference
+ ^^^^^^^^^^^^^
- .. grid-item-card::
- :img-top: _static/index_api.png
+ The reference guide contains a detailed description of
+ the SciPy API. The reference describes how the methods work and which parameters can
+ be used. It assumes that you have an understanding of the key concepts.
- API reference
- ^^^^^^^^^^^^^
+ +++
- The reference guide contains a detailed description of
- the SciPy API. 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:: scipy-api
+ :type: ref
+ :text: To the reference guide
+ :classes: btn-block btn-secondary stretched-link
- +++
+ ---
+ :img-top: _static/index_contribute.png
- .. button-ref:: scipy-api
- :expand:
- :color: secondary
- :click-parent:
+ Developer guide
+ ^^^^^^^^^^^^^^^
- To the reference guide
+ Saw a typo in the documentation? Want to improve
+ existing functionalities? The contributing guidelines will guide
+ you through the process of improving SciPy.
- .. grid-item-card::
- :img-top: _static/index_contribute.png
+ +++
- Developer guide
- ^^^^^^^^^^^^^^^
-
- Saw a typo in the documentation? Want to improve
- existing functionalities? The contributing guidelines will guide
- you through the process of improving SciPy.
-
- +++
-
- .. button-ref:: scipy-development
- :expand:
- :color: secondary
- :click-parent:
-
- To the development guide
+ .. link-button:: scipy-development
+ :type: ref
+ :text: To the development guide
+ :classes: btn-block btn-secondary stretched-link
.. toctree::
:maxdepth: 1
projects / scipy.git / commitdiff