1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
.. _install:
{{ header }}
============
Installation
============
The easiest way to install pandas is to install it
as part of the `Anaconda <https://docs.continuum.io/free/anaconda/>`__ distribution, a
cross platform distribution for data analysis and scientific computing.
The `Conda <https://conda.io/en/latest/>`__ package manager is the
recommended installation method for most users.
Instructions for installing :ref:`from source <install.source>`,
:ref:`PyPI <install.pypi>`, or a
:ref:`development version <install.dev>` are also provided.
.. _install.version:
Python version support
----------------------
Officially Python 3.9, 3.10, 3.11 and 3.12.
Installing pandas
-----------------
.. _install.anaconda:
Installing with Anaconda
~~~~~~~~~~~~~~~~~~~~~~~~
For users that are new to Python, the easiest way to install Python, pandas, and the
packages that make up the `PyData <https://pydata.org/>`__ stack
(`SciPy <https://scipy.org/>`__, `NumPy <https://numpy.org/>`__,
`Matplotlib <https://matplotlib.org/>`__, `and more <https://docs.continuum.io/free/anaconda/reference/packages/pkg-docs/>`__)
is with `Anaconda <https://docs.continuum.io/free/anaconda/>`__, a cross-platform
(Linux, macOS, Windows) Python distribution for data analytics and
scientific computing. Installation instructions for Anaconda
`can be found here <https://docs.continuum.io/free/anaconda/install/>`__.
.. _install.miniconda:
Installing with Miniconda
~~~~~~~~~~~~~~~~~~~~~~~~~
For users experienced with Python, the recommended way to install pandas with
`Miniconda <https://docs.conda.io/en/latest/miniconda.html>`__.
Miniconda allows you to create a minimal, self-contained Python installation compared to Anaconda and use the
`Conda <https://conda.io/en/latest/>`__ package manager to install additional packages
and create a virtual environment for your installation. Installation instructions for Miniconda
`can be found here <https://docs.conda.io/en/latest/miniconda.html>`__.
The next step is to create a new conda environment. A conda environment is like a
virtualenv that allows you to specify a specific version of Python and set of libraries.
Run the following commands from a terminal window.
.. code-block:: shell
conda create -c conda-forge -n name_of_my_env python pandas
This will create a minimal environment with only Python and pandas installed.
To put your self inside this environment run.
.. code-block:: shell
source activate name_of_my_env
# On Windows
activate name_of_my_env
.. _install.pypi:
Installing from PyPI
~~~~~~~~~~~~~~~~~~~~
pandas can be installed via pip from
`PyPI <https://pypi.org/project/pandas>`__.
.. code-block:: shell
pip install pandas
.. note::
You must have ``pip>=19.3`` to install from PyPI.
.. note::
It is recommended to install and run pandas from a virtual environment, for example,
using the Python standard library's `venv <https://docs.python.org/3/library/venv.html>`__
pandas can also be installed with sets of optional dependencies to enable certain functionality. For example,
to install pandas with the optional dependencies to read Excel files.
.. code-block:: shell
pip install "pandas[excel]"
The full list of extras that can be installed can be found in the :ref:`dependency section.<install.optional_dependencies>`
Handling ImportErrors
~~~~~~~~~~~~~~~~~~~~~
If you encounter an ``ImportError``, it usually means that Python couldn't find pandas in the list of available
libraries. Python internally has a list of directories it searches through, to find packages. You can
obtain these directories with.
.. code-block:: python
import sys
sys.path
One way you could be encountering this error is if you have multiple Python installations on your system
and you don't have pandas installed in the Python installation you're currently using.
In Linux/Mac you can run ``which python`` on your terminal and it will tell you which Python installation you're
using. If it's something like "/usr/bin/python", you're using the Python from the system, which is not recommended.
It is highly recommended to use ``conda``, for quick installation and for package and dependency updates.
You can find simple installation instructions for pandas :ref:`in this document <install.miniconda>`.
.. _install.source:
Installing from source
~~~~~~~~~~~~~~~~~~~~~~
See the :ref:`contributing guide <contributing>` for complete instructions on building from the git source tree.
Further, see :ref:`creating a development environment <contributing_environment>` if you wish to create
a pandas development environment.
.. _install.dev:
Installing the development version of pandas
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Installing the development version is the quickest way to:
* Try a new feature that will be shipped in the next release (that is, a feature from a pull-request that was recently merged to the main branch).
* Check whether a bug you encountered has been fixed since the last release.
The development version is usually uploaded daily to the scientific-python-nightly-wheels
index from the PyPI registry of anaconda.org. You can install it by running.
.. code-block:: shell
pip install --pre --extra-index https://pypi.anaconda.org/scientific-python-nightly-wheels/simple pandas
Note that you might be required to uninstall an existing version of pandas to install the development version.
.. code-block:: shell
pip uninstall pandas -y
Running the test suite
----------------------
pandas is equipped with an exhaustive set of unit tests. The packages required to run the tests
can be installed with ``pip install "pandas[test]"``. To run the tests from a
Python terminal.
.. code-block:: python
>>> import pandas as pd
>>> pd.test()
running: pytest -m "not slow and not network and not db" /home/user/anaconda3/lib/python3.9/site-packages/pandas
============================= test session starts ==============================
platform linux -- Python 3.9.7, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
rootdir: /home/user
plugins: dash-1.19.0, anyio-3.5.0, hypothesis-6.29.3
collected 154975 items / 4 skipped / 154971 selected
........................................................................ [ 0%]
........................................................................ [ 99%]
....................................... [100%]
==================================== ERRORS ====================================
=================================== FAILURES ===================================
=============================== warnings summary ===============================
=========================== short test summary info ============================
= 1 failed, 146194 passed, 7402 skipped, 1367 xfailed, 5 xpassed, 197 warnings, 10 errors in 1090.16s (0:18:10) =
.. note::
This is just an example of what information is shown. Test failures are not necessarily indicative
of a broken pandas installation.
.. _install.dependencies:
Dependencies
------------
.. _install.required_dependencies:
Required dependencies
~~~~~~~~~~~~~~~~~~~~~
pandas requires the following dependencies.
================================================================ ==========================
Package Minimum supported version
================================================================ ==========================
`NumPy <https://numpy.org>`__ 1.22.4
`python-dateutil <https://dateutil.readthedocs.io/en/stable/>`__ 2.8.2
`pytz <https://pypi.org/project/pytz/>`__ 2020.1
`tzdata <https://pypi.org/project/tzdata/>`__ 2022.7
================================================================ ==========================
.. _install.optional_dependencies:
Optional dependencies
~~~~~~~~~~~~~~~~~~~~~
pandas has many optional dependencies that are only used for specific methods.
For example, :func:`pandas.read_hdf` requires the ``pytables`` package, while
:meth:`DataFrame.to_markdown` requires the ``tabulate`` package. If the
optional dependency is not installed, pandas will raise an ``ImportError`` when
the method requiring that dependency is called.
If using pip, optional pandas dependencies can be installed or managed in a file (e.g. requirements.txt or pyproject.toml)
as optional extras (e.g. ``pandas[performance, aws]``). All optional dependencies can be installed with ``pandas[all]``,
and specific sets of dependencies are listed in the sections below.
.. _install.recommended_dependencies:
Performance dependencies (recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. note::
You are highly encouraged to install these libraries, as they provide speed improvements, especially
when working with large data sets.
Installable with ``pip install "pandas[performance]"``
===================================================== ================== ================== ===================================================================================================================================================================================
Dependency Minimum Version pip extra Notes
===================================================== ================== ================== ===================================================================================================================================================================================
`numexpr <https://github.com/pydata/numexpr>`__ 2.8.4 performance Accelerates certain numerical operations by using multiple cores as well as smart chunking and caching to achieve large speedups
`bottleneck <https://github.com/pydata/bottleneck>`__ 1.3.6 performance Accelerates certain types of ``nan`` by using specialized cython routines to achieve large speedup.
`numba <https://github.com/numba/numba>`__ 0.56.4 performance Alternative execution engine for operations that accept ``engine="numba"`` using a JIT compiler that translates Python functions to optimized machine code using the LLVM compiler.
===================================================== ================== ================== ===================================================================================================================================================================================
Visualization
^^^^^^^^^^^^^
Installable with ``pip install "pandas[plot, output-formatting]"``.
========================= ================== ================== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== ================== =============================================================
matplotlib 3.6.3 plot Plotting library
Jinja2 3.1.2 output-formatting Conditional formatting with DataFrame.style
tabulate 0.9.0 output-formatting Printing in Markdown-friendly format (see `tabulate`_)
========================= ================== ================== =============================================================
Computation
^^^^^^^^^^^
Installable with ``pip install "pandas[computation]"``.
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
SciPy 1.10.0 computation Miscellaneous statistical functions
xarray 2022.12.0 computation pandas-like API for N-dimensional data
========================= ================== =============== =============================================================
Excel files
^^^^^^^^^^^
Installable with ``pip install "pandas[excel]"``.
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
xlrd 2.0.1 excel Reading Excel
xlsxwriter 3.0.5 excel Writing Excel
openpyxl 3.1.0 excel Reading / writing for xlsx files
pyxlsb 1.0.10 excel Reading for xlsb files
python-calamine 0.1.7 excel Reading for xls/xlsx/xlsb/ods files
========================= ================== =============== =============================================================
HTML
^^^^
Installable with ``pip install "pandas[html]"``.
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
BeautifulSoup4 4.11.2 html HTML parser for read_html
html5lib 1.1 html HTML parser for read_html
lxml 4.9.2 html HTML parser for read_html
========================= ================== =============== =============================================================
One of the following combinations of libraries is needed to use the
top-level :func:`~pandas.read_html` function:
* `BeautifulSoup4`_ and `html5lib`_
* `BeautifulSoup4`_ and `lxml`_
* `BeautifulSoup4`_ and `html5lib`_ and `lxml`_
* Only `lxml`_, although see :ref:`HTML Table Parsing <io.html.gotchas>`
for reasons as to why you should probably **not** take this approach.
.. warning::
* if you install `BeautifulSoup4`_ you must install either
`lxml`_ or `html5lib`_ or both.
:func:`~pandas.read_html` will **not** work with *only*
`BeautifulSoup4`_ installed.
* You are highly encouraged to read :ref:`HTML Table Parsing gotchas <io.html.gotchas>`.
It explains issues surrounding the installation and
usage of the above three libraries.
.. _html5lib: https://github.com/html5lib/html5lib-python
.. _BeautifulSoup4: https://www.crummy.com/software/BeautifulSoup
.. _lxml: https://lxml.de
.. _tabulate: https://github.com/astanin/python-tabulate
XML
^^^
Installable with ``pip install "pandas[xml]"``.
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
lxml 4.9.2 xml XML parser for read_xml and tree builder for to_xml
========================= ================== =============== =============================================================
SQL databases
^^^^^^^^^^^^^
Traditional drivers are installable with ``pip install "pandas[postgresql, mysql, sql-other]"``
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
SQLAlchemy 2.0.0 postgresql, SQL support for databases other than sqlite
mysql,
sql-other
psycopg2 2.9.6 postgresql PostgreSQL engine for sqlalchemy
pymysql 1.0.2 mysql MySQL engine for sqlalchemy
adbc-driver-postgresql 0.8.0 postgresql ADBC Driver for PostgreSQL
adbc-driver-sqlite 0.8.0 sql-other ADBC Driver for SQLite
========================= ================== =============== =============================================================
Other data sources
^^^^^^^^^^^^^^^^^^
Installable with ``pip install "pandas[hdf5, parquet, feather, spss, excel]"``
========================= ================== ================ =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== ================ =============================================================
PyTables 3.8.0 hdf5 HDF5-based reading / writing
blosc 1.21.3 hdf5 Compression for HDF5; only available on ``conda``
zlib hdf5 Compression for HDF5
fastparquet 2022.12.0 - Parquet reading / writing (pyarrow is default)
pyarrow 10.0.1 parquet, feather Parquet, ORC, and feather reading / writing
pyreadstat 1.2.0 spss SPSS files (.sav) reading
odfpy 1.4.1 excel Open document format (.odf, .ods, .odt) reading / writing
========================= ================== ================ =============================================================
.. _install.warn_orc:
.. warning::
* If you want to use :func:`~pandas.read_orc`, it is highly recommended to install pyarrow using conda.
:func:`~pandas.read_orc` may fail if pyarrow was installed from pypi, and :func:`~pandas.read_orc` is
not compatible with Windows OS.
Access data in the cloud
^^^^^^^^^^^^^^^^^^^^^^^^
Installable with ``pip install "pandas[fss, aws, gcp]"``
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
fsspec 2022.11.0 fss, gcp, aws Handling files aside from simple local and HTTP (required
dependency of s3fs, gcsfs).
gcsfs 2022.11.0 gcp Google Cloud Storage access
pandas-gbq 0.19.0 gcp Google Big Query access
s3fs 2022.11.0 aws Amazon S3 access
========================= ================== =============== =============================================================
Clipboard
^^^^^^^^^
Installable with ``pip install "pandas[clipboard]"``.
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
PyQt4/PyQt5 5.15.9 clipboard Clipboard I/O
qtpy 2.3.0 clipboard Clipboard I/O
========================= ================== =============== =============================================================
.. note::
Depending on operating system, system-level packages may need to installed.
For clipboard to operate on Linux one of the CLI tools ``xclip`` or ``xsel`` must be installed on your system.
Compression
^^^^^^^^^^^
Installable with ``pip install "pandas[compression]"``
========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
Zstandard 0.19.0 compression Zstandard compression
========================= ================== =============== =============================================================
Consortium Standard
^^^^^^^^^^^^^^^^^^^
Installable with ``pip install "pandas[consortium-standard]"``
========================= ================== =================== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =================== =============================================================
dataframe-api-compat 0.1.7 consortium-standard Consortium Standard-compatible implementation based on pandas
========================= ================== =================== =============================================================
|
