Skip to content

Commit 2b7af84

Browse files
smij720mroeschke
andauthored
DOC: Add clarifications to docs for setting up a development environment (#56201)
* Make docs clearer for mamba installation * Add mamba python package update instruction * Tidy * Update doc/source/development/contributing_environment.rst Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com> * Remove surplus instruction step --------- Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
1 parent 4c520e3 commit 2b7af84

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

doc/source/development/contributing_environment.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ and consult the ``Linux`` instructions below.
4444
**macOS**
4545

4646
To use the :ref:`mamba <contributing.mamba>`-based compilers, you will need to install the
47-
Developer Tools using ``xcode-select --install``. Otherwise
48-
information about compiler installation can be found here:
47+
Developer Tools using ``xcode-select --install``.
48+
49+
If you prefer to use a different compiler, general information can be found here:
4950
https://devguide.python.org/setup/#macos
5051

5152
**Linux**
@@ -86,12 +87,12 @@ Before we begin, please:
8687
Option 1: using mamba (recommended)
8788
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8889

89-
* Install `mamba <https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html>`_
90+
* Install miniforge to get `mamba <https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html>`_
9091
* Make sure your mamba is up to date (``mamba update mamba``)
92+
* Create and activate the ``pandas-dev`` mamba environment using the following commands:
9193

9294
.. code-block:: none
9395
94-
# Create and activate the build environment
9596
mamba env create --file environment.yml
9697
mamba activate pandas-dev
9798
@@ -273,13 +274,21 @@ uses to import the extension from the build folder, which may cause errors such
273274
You will need to repeat this step each time the C extensions change, for example
274275
if you modified any file in ``pandas/_libs`` or if you did a fetch and merge from ``upstream/main``.
275276

277+
**Checking the build**
278+
276279
At this point you should be able to import pandas from your locally built version::
277280

278281
$ python
279282
>>> import pandas
280283
>>> print(pandas.__version__) # note: the exact output may differ
281284
2.0.0.dev0+880.g2b9e661fbb.dirty
282285

286+
287+
At this point you may want to try
288+
`running the test suite <https://pandas.pydata.org/docs/dev/development/contributing_codebase.html#running-the-test-suite>`_.
289+
290+
**Keeping up to date with the latest build**
291+
283292
When building pandas with meson, importing pandas will automatically trigger a rebuild, even when C/Cython files are modified.
284293
By default, no output will be produced by this rebuild (the import will just take longer). If you would like to see meson's
285294
output when importing pandas, you can set the environment variable ``MESONPY_EDTIABLE_VERBOSE``. For example, this would be::

0 commit comments

Comments
 (0)