Skip to content

Commit

Permalink
Revise Install Guide to provide better, more up to date guidance (#335)
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach authored Nov 14, 2022
2 parents bb9b308 + 2161a97 commit fb5b374
Show file tree
Hide file tree
Showing 8 changed files with 254 additions and 126 deletions.
6 changes: 5 additions & 1 deletion doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ Using Spyder
:start: 306


.. _using-existing-environment:

.. dropdown:: Q: How do I get Spyder to work with my existing Python packages/environment?
:container: + dropdown-id-using-existing-environment

Expand All @@ -196,6 +198,8 @@ Using Spyder
Click :guilabel:`Restart kernel` in the :guilabel:`Consoles` menu for this change to take effect.


.. _using-packages-installer:

.. dropdown:: Q: How do I install Python packages to use within Spyder if I downloaded Spyder from the standalone installers?
:container: + dropdown-id-using-packages-installer

Expand Down Expand Up @@ -435,7 +439,7 @@ About Spyder
If you use Spyder with the Anaconda distribution, they `recently changed`_ their `Terms of Service`_ to add restrictions on large (> 200 employee) for-profit companies using Anaconda on a large scale.
However, these terms only apply to the package infrastructure (the full Anaconda distribution and the ``defaults`` conda channel).
Instead, you can simply download the similar `Miniforge distribution`_, which is 100% open source and identical to full Anaconda (aside from not bundling the Python packages installed by default in the Anaconda ``base`` environment, which we recommend you avoid using anyway given any problems here can break your whole installation).
Then, simply install the packages you need (including Spyder, if you aren't using our recommended :ref:`standalone_installers_ref`) with ``conda`` as you usually do.
Then, simply install the packages you need (including Spyder, if you aren't using our recommended :ref:`install-standalone`) with ``conda`` as you usually do.
Miniforge will automatically use the community-maintained Conda-Forge repository, which has a much wider variety of packages and is generally more up to date than the Anaconda equivalent, in addition to being free of any commercial restrictions.
For more, see our :doc:`/installation`.

Expand Down
358 changes: 241 additions & 117 deletions doc/installation.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/plugins/lineprofiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you installed Spyder using conda, the best way to obtain Spyder-Line-Profiler
.. important::

At the moment it is not possible to use this plugin with the Spyder :ref:`standalone_installers_ref` for Windows and macOS.
At the moment it is not possible to use this plugin with the Spyder :ref:`install-standalone` for Windows and macOS.
We're working to add support for them in the future.

Restart Spyder in order to be able to use the plugin.
Expand Down
2 changes: 1 addition & 1 deletion doc/plugins/notebook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you installed Spyder using conda, the best way to install Spyder-notebook is
.. important::

At the moment it is not possible to use this plugin with the Spyder :ref:`standalone_installers_ref` for Windows and macOS. We're working to make that possible in the future.
At the moment it is not possible to use this plugin with the Spyder :ref:`install-standalone` for Windows and macOS. We're working to make that possible in the future.

Restart Spyder in order to be able to use the plugin.

Expand Down
2 changes: 1 addition & 1 deletion doc/plugins/terminal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you installed Spyder using conda, the best way to install Spyder-terminal is
.. important::

At the moment it is not possible to use this plugin with the Spyder :ref:`standalone_installers_ref` for Windows and macOS. We're working to make that possible in the future.
At the moment it is not possible to use this plugin with the Spyder :ref:`install-standalone` for Windows and macOS. We're working to make that possible in the future.

Restart Spyder in order to be able to use the plugin.

Expand Down
4 changes: 2 additions & 2 deletions doc/workshops/financial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You will also need to have `Anaconda <https://www.anaconda.com/products/individu

.. important::

Spyder now offers :ref:`standalone_installers_ref` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
Spyder now offers :ref:`install-standalone` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
While we still support Anaconda, we recommend this install method on those platforms to avoid most problems with package conflicts and other issues.


Expand Down Expand Up @@ -153,7 +153,7 @@ To install Spyder's optional dependencies as well for full functionality, use th
.. important::

Spyder now offers :ref:`standalone_installers_ref` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
Spyder now offers :ref:`install-standalone` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.


Download the datasets
Expand Down
2 changes: 1 addition & 1 deletion doc/workshops/plugin-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You will need to have Spyder installed. Visit our :doc:`installation guide<../in

.. important::

Spyder now offers :ref:`standalone_installers_ref` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
Spyder now offers :ref:`install-standalone` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
However, readers of this workshop should install Spyder using Anaconda or Miniconda, as standalone installers currently do not allow to add extra packages like the plugin we are going to develop in this workshop.

It is also desirable to have the following prior knowledge:
Expand Down
4 changes: 2 additions & 2 deletions doc/workshops/scientific-computing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You will need to have Spyder installed. Visit our :doc:`installation guide<../in

.. important::

Spyder now offers :ref:`standalone_installers_ref` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
Spyder now offers :ref:`install-standalone` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment.
While we still support Anaconda, we recommend this install method on those platforms to avoid most problems with package conflicts and other issues.

It is also desirable to have the following prior knowledge:
Expand Down Expand Up @@ -173,7 +173,7 @@ To install Spyder's optional dependencies as well for full functionality, use th
.. warning::

Spyder now offers :ref:`standalone_installers_ref` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment. If you use the standalone installer, there is no need to install ``spyder=5`` with conda.
Spyder now offers :ref:`install-standalone` for Windows and macOS, making it easier to get up and running with the application without having to download Anaconda or manually install it in your existing environment. If you use the standalone installer, there is no need to install ``spyder=5`` with conda.


2. From an environment.yml file
Expand Down

0 comments on commit fb5b374

Please sign in to comment.