Skip to content

Commit feec5c1

Browse files
antquinonezjorisvandenbossche
authored andcommitted
DOC: Edit installation instructions for clarity. (#19798)
1 parent f8dfcfb commit feec5c1

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

doc/source/install.rst

+15-18
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Installation
77
============
88

9-
The easiest way for the majority of users to install pandas is to install it
9+
The easiest way to install pandas is to install it
1010
as part of the `Anaconda <http://docs.continuum.io/anaconda/>`__ distribution, a
1111
cross platform distribution for data analysis and scientific computing.
1212
This is the recommended installation method for most users.
@@ -40,7 +40,7 @@ packages that make up the `SciPy <http://www.scipy.org/>`__ stack
4040
(Linux, Mac OS X, Windows) Python distribution for data analytics and
4141
scientific computing.
4242

43-
After running a simple installer, the user will have access to pandas and the
43+
After running the installer, the user will have access to pandas and the
4444
rest of the `SciPy <http://www.scipy.org/>`__ stack without needing to install
4545
anything else, and without needing to wait for any software to be compiled.
4646

@@ -51,9 +51,9 @@ A full list of the packages available as part of the
5151
`Anaconda <http://docs.continuum.io/anaconda/>`__ distribution
5252
`can be found here <http://docs.continuum.io/anaconda/pkg-docs.html>`__.
5353

54-
An additional advantage of installing with Anaconda is that you don't require
55-
admin rights to install it, it will install in the user's home directory, and
56-
this also makes it trivial to delete Anaconda at a later date (just delete
54+
Another advantage to installing Anaconda is that you don't need
55+
admin rights to install it. Anaconda can install in the user's home directory,
56+
which makes it trivial to delete Anaconda if you decide (just delete
5757
that folder).
5858

5959
.. _install.miniconda:
@@ -85,9 +85,9 @@ downloading and running the `Miniconda
8585
will do this for you. The installer
8686
`can be found here <http://conda.pydata.org/miniconda.html>`__
8787

88-
The next step is to create a new conda environment (these are analogous to a
89-
virtualenv but they also allow you to specify precisely which Python version
90-
to install also). Run the following commands from a terminal window::
88+
The next step is to create a new conda environment. A conda environment is like a
89+
virtualenv that allows you to specify a specific version of Python and set of libraries.
90+
Run the following commands from a terminal window::
9191

9292
conda create -n name_of_my_env python
9393

@@ -118,8 +118,8 @@ distribution::
118118

119119
conda install anaconda
120120

121-
If you require any packages that are available to pip but not conda, simply
122-
install pip, and use pip to install these packages::
121+
If you need packages that are available to pip but not conda, then
122+
install pip, and then use pip to install those packages::
123123

124124
conda install pip
125125
pip install django
@@ -134,15 +134,12 @@ pandas can be installed via pip from
134134

135135
pip install pandas
136136

137-
This will likely require the installation of a number of dependencies,
138-
including NumPy, will require a compiler to compile required bits of code,
139-
and can take a few minutes to complete.
140137

141138
Installing using your Linux distribution's package manager.
142139
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143140

144141
The commands in this table will install pandas for Python 3 from your distribution.
145-
To install pandas for Python 2 you may need to use the package ``python-pandas``.
142+
To install pandas for Python 2, you may need to use the ``python-pandas`` package.
146143

147144
.. csv-table::
148145
:header: "Distribution", "Status", "Download / Repository Link", "Install method"
@@ -169,9 +166,9 @@ See the :ref:`contributing documentation <contributing>` for complete instructio
169166
Running the test suite
170167
~~~~~~~~~~~~~~~~~~~~~~
171168

172-
pandas is equipped with an exhaustive set of unit tests covering about 97% of
169+
pandas is equipped with an exhaustive set of unit tests, covering about 97% of
173170
the codebase as of this writing. To run it on your machine to verify that
174-
everything is working (and you have all of the dependencies, soft and hard,
171+
everything is working (and that you have all of the dependencies, soft and hard,
175172
installed), make sure you have `pytest
176173
<http://doc.pytest.org/en/latest/>`__ and run:
177174

@@ -214,8 +211,8 @@ Recommended Dependencies
214211

215212
.. note::
216213

217-
You are highly encouraged to install these libraries, as they provide large speedups, especially
218-
if working with large data sets.
214+
You are highly encouraged to install these libraries, as they provide speed improvements, especially
215+
when working with large data sets.
219216

220217

221218
.. _install.optional_dependencies:

0 commit comments

Comments
 (0)