@@ -146,7 +146,7 @@ Creating a development environment
146
146
----------------------------------
147
147
148
148
To test out code changes, you'll need to build pandas from source, which
149
- requires a C compiler and Python environment. If you're making documentation
149
+ requires a C/C++ compiler and Python environment. If you're making documentation
150
150
changes, you can skip to :ref: `contributing.documentation ` but you won't be able
151
151
to build the documentation locally before pushing your changes.
152
152
@@ -183,7 +183,7 @@ See https://www.jetbrains.com/help/pycharm/docker.html for details.
183
183
184
184
Note that you might need to rebuild the C extensions if/when you merge with upstream/master using::
185
185
186
- python setup.py build_ext --inplace - j 4
186
+ python setup.py build_ext -j 4
187
187
188
188
.. _contributing.dev_c :
189
189
@@ -195,6 +195,13 @@ operations. To install pandas from source, you need to compile these C
195
195
extensions, which means you need a C compiler. This process depends on which
196
196
platform you're using.
197
197
198
+ If you have setup your environment using ``conda ``, the packages ``c-compiler ``
199
+ and ``cxx-compiler `` will install a fitting compiler for your platform that is
200
+ compatible with the remaining conda packages. On Windows and macOS, you will
201
+ also need to install the SDKs as they have to be distributed separately.
202
+ These packages will be automatically installed by using ``pandas ``'s
203
+ ``environment.yml ``.
204
+
198
205
**Windows **
199
206
200
207
You will need `Build Tools for Visual Studio 2017
@@ -206,12 +213,33 @@ You will need `Build Tools for Visual Studio 2017
206
213
scrolling down to "All downloads" -> "Tools for Visual Studio 2019".
207
214
In the installer, select the "C++ build tools" workload.
208
215
216
+ You can install the necessary components on the commandline using
217
+ `vs_buildtools.exe <https://aka.ms/vs/16/release/vs_buildtools.exe >`_:
218
+
219
+ .. code ::
220
+
221
+ vs_buildtools.exe --quiet --wait --norestart --nocache ^
222
+ --installPath C:\BuildTools ^
223
+ --add "Microsoft.VisualStudio.Workload.VCTools;includeRecommended" ^
224
+ --add Microsoft.VisualStudio.Component.VC.v141 ^
225
+ --add Microsoft.VisualStudio.Component.VC.v141.x86.x64 ^
226
+ --add Microsoft.VisualStudio.Component.Windows10SDK.17763
227
+
228
+ To setup the right paths on the commandline, call
229
+ ``"C:\BuildTools\VC\Auxiliary\Build\vcvars64.bat" -vcvars_ver=14.16 10.0.17763.0 ``.
230
+
209
231
**macOS **
210
232
211
- Information about compiler installation can be found here:
233
+ To use the ``conda ``-based compilers, you will need to install the
234
+ Developer Tools using ``xcode-select --install ``. Otherwise
235
+ information about compiler installation can be found here:
212
236
https://devguide.python.org/setup/#macos
213
237
214
- **Unix **
238
+ **Linux **
239
+
240
+ For Linux-based ``conda `` installations, you won't have to install any
241
+ additional components outside of the conda environment. The instructions
242
+ below are only needed if your setup isn't based on conda environments.
215
243
216
244
Some Linux distributions will come with a pre-installed C compiler. To find out
217
245
which compilers (and versions) are installed on your system::
@@ -243,11 +271,10 @@ Let us know if you have any difficulties by opening an issue or reaching out on
243
271
Creating a Python environment
244
272
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
245
273
246
- Now that you have a C compiler, create an isolated pandas development
247
- environment:
274
+ Now create an isolated pandas development environment:
248
275
249
- * Install either `Anaconda <https://www.anaconda.com/download/ >`_ or `miniconda
250
- <https://conda.io/miniconda.html> `_
276
+ * Install either `Anaconda <https://www.anaconda.com/download/ >`_, `miniconda
277
+ <https://conda.io/miniconda.html> `_, or ` miniforge < https://github.com/conda-forge/miniforge >`_
251
278
* Make sure your conda is up to date (``conda update conda ``)
252
279
* Make sure that you have :ref: `cloned the repository <contributing.forking >`
253
280
* ``cd `` to the pandas source directory
@@ -268,7 +295,7 @@ We'll now kick off a three-step process:
268
295
source activate pandas-dev
269
296
270
297
# Build and install pandas
271
- python setup.py build_ext --inplace - j 4
298
+ python setup.py build_ext -j 4
272
299
python -m pip install -e . --no-build-isolation --no-use-pep517
273
300
274
301
At this point you should be able to import pandas from your locally built version::
@@ -315,7 +342,7 @@ You'll need to have at least Python 3.6.1 installed on your system.
315
342
python -m pip install -r requirements-dev.txt
316
343
317
344
# Build and install pandas
318
- python setup.py build_ext --inplace - j 4
345
+ python setup.py build_ext -j 4
319
346
python -m pip install -e . --no-build-isolation --no-use-pep517
320
347
321
348
**Unix **/**macOS with pyenv **
@@ -339,7 +366,7 @@ Consult the docs for setting up pyenv `here <https://github.com/pyenv/pyenv>`__.
339
366
python -m pip install -r requirements-dev.txt
340
367
341
368
# Build and install pandas
342
- python setup.py build_ext --inplace - j 4
369
+ python setup.py build_ext -j 4
343
370
python -m pip install -e . --no-build-isolation --no-use-pep517
344
371
345
372
**Windows **
@@ -365,7 +392,7 @@ should already exist.
365
392
python - m pip install - r requirements- dev.txt
366
393
367
394
# Build and install pandas
368
- python setup.py build_ext -- inplace - j 4
395
+ python setup.py build_ext - j 4
369
396
python - m pip install - e . -- no- build-isolation -- no- use-pep517
370
397
371
398
Creating a branch
0 commit comments