Skip to content

Commit 23c497b

Browse files
authored
DOC: Recommend conda from miniforge for contributing environment (#59894)
1 parent b948821 commit 23c497b

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

doc/source/development/contributing.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -305,15 +305,15 @@ It is important to periodically update your local ``main`` branch with updates f
305305
branch and update your development environment to reflect any changes to the various packages that
306306
are used during development.
307307

308-
If using :ref:`mamba <contributing.mamba>`, run:
308+
If using :ref:`conda <contributing.conda>`, run:
309309

310310
.. code-block:: shell
311311
312312
git checkout main
313313
git fetch upstream
314314
git merge upstream/main
315-
mamba activate pandas-dev
316-
mamba env update -f environment.yml --prune
315+
conda activate pandas-dev
316+
conda env update -f environment.yml --prune
317317
318318
If using :ref:`pip <contributing.pip>` , do:
319319

doc/source/development/contributing_codebase.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ in your python environment.
244244

245245
.. warning::
246246

247-
* Please be aware that the above commands will use the current python environment. If your python packages are older/newer than those installed by the pandas CI, the above commands might fail. This is often the case when the ``mypy`` or ``numpy`` versions do not match. Please see :ref:`how to setup the python environment <contributing.mamba>` or select a `recently succeeded workflow <https://github.com/pandas-dev/pandas/actions/workflows/code-checks.yml?query=branch%3Amain+is%3Asuccess>`_, select the "Docstring validation, typing, and other manual pre-commit hooks" job, then click on "Set up Conda" and "Environment info" to see which versions the pandas CI installs.
247+
* Please be aware that the above commands will use the current python environment. If your python packages are older/newer than those installed by the pandas CI, the above commands might fail. This is often the case when the ``mypy`` or ``numpy`` versions do not match. Please see :ref:`how to setup the python environment <contributing.conda>` or select a `recently succeeded workflow <https://github.com/pandas-dev/pandas/actions/workflows/code-checks.yml?query=branch%3Amain+is%3Asuccess>`_, select the "Docstring validation, typing, and other manual pre-commit hooks" job, then click on "Set up Conda" and "Environment info" to see which versions the pandas CI installs.
248248

249249
.. _contributing.ci:
250250

doc/source/development/contributing_environment.rst

+11-12
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ and consult the ``Linux`` instructions below.
4343

4444
**macOS**
4545

46-
To use the :ref:`mamba <contributing.mamba>`-based compilers, you will need to install the
46+
To use the :ref:`conda <contributing.conda>`-based compilers, you will need to install the
4747
Developer Tools using ``xcode-select --install``.
4848

4949
If you prefer to use a different compiler, general information can be found here:
5050
https://devguide.python.org/setup/#macos
5151

5252
**Linux**
5353

54-
For Linux-based :ref:`mamba <contributing.mamba>` installations, you won't have to install any
55-
additional components outside of the mamba environment. The instructions
56-
below are only needed if your setup isn't based on mamba environments.
54+
For Linux-based :ref:`conda <contributing.conda>` installations, you won't have to install any
55+
additional components outside of the conda environment. The instructions
56+
below are only needed if your setup isn't based on conda environments.
5757

5858
Some Linux distributions will come with a pre-installed C compiler. To find out
5959
which compilers (and versions) are installed on your system::
@@ -82,19 +82,18 @@ Before we begin, please:
8282
* Make sure that you have :any:`cloned the repository <contributing.forking>`
8383
* ``cd`` to the pandas source directory you just created with the clone command
8484

85-
.. _contributing.mamba:
85+
.. _contributing.conda:
8686

87-
Option 1: using mamba (recommended)
87+
Option 1: using conda (recommended)
8888
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8989

90-
* Install miniforge to get `mamba <https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html>`_
91-
* Make sure your mamba is up to date (``mamba update mamba``)
92-
* Create and activate the ``pandas-dev`` mamba environment using the following commands:
90+
* Install miniforge to get `conda <https://github.com/conda-forge/miniforge?tab=readme-ov-file#download>`_
91+
* Create and activate the ``pandas-dev`` conda environment using the following commands:
9392

94-
.. code-block:: none
93+
.. code-block:: bash
9594
96-
mamba env create --file environment.yml
97-
mamba activate pandas-dev
95+
conda env create --file environment.yml
96+
conda activate pandas-dev
9897
9998
.. _contributing.pip:
10099

0 commit comments

Comments
 (0)