From b42e817d4484a209967a3478e73c39ff1a54ce8b Mon Sep 17 00:00:00 2001 From: smij720 Date: Sun, 26 Nov 2023 18:02:03 -0800 Subject: [PATCH 1/5] Make docs clearer for mamba installation --- .../development/contributing_environment.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 7fc42f6021f00..f2a8880079367 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -44,8 +44,9 @@ and consult the ``Linux`` instructions below. **macOS** To use the :ref:`mamba `-based compilers, you will need to install the -Developer Tools using ``xcode-select --install``. Otherwise -information about compiler installation can be found here: +Developer Tools using ``xcode-select --install``. + +If you prefer to use a different compiler, general information can be found here: https://devguide.python.org/setup/#macos **Linux** @@ -87,11 +88,13 @@ Option 1: using mamba (recommended) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Install `mamba `_ + (the instructions may direct you to install `miniforge `_, + which is OK - it includes mamba) * Make sure your mamba is up to date (``mamba update mamba``) +* Create and activate the ``pandas-dev`` mamba environment using the following commands: .. code-block:: none - # Create and activate the build environment mamba env create --file environment.yml mamba activate pandas-dev @@ -273,6 +276,8 @@ uses to import the extension from the build folder, which may cause errors such You will need to repeat this step each time the C extensions change, for example if you modified any file in ``pandas/_libs`` or if you did a fetch and merge from ``upstream/main``. +**Checking the build** + At this point you should be able to import pandas from your locally built version:: $ python @@ -280,6 +285,12 @@ At this point you should be able to import pandas from your locally built versio >>> print(pandas.__version__) # note: the exact output may differ 2.0.0.dev0+880.g2b9e661fbb.dirty + +At this point you may want to try +`running the test suite `_. + +**Keeping up to date with the latest build** + When building pandas with meson, importing pandas will automatically trigger a rebuild, even when C/Cython files are modified. By default, no output will be produced by this rebuild (the import will just take longer). If you would like to see meson's output when importing pandas, you can set the environment variable ``MESONPY_EDTIABLE_VERBOSE``. For example, this would be:: From 40203d85933ea1f83a1666614f424f2d0f67608d Mon Sep 17 00:00:00 2001 From: smij720 Date: Sun, 26 Nov 2023 18:28:03 -0800 Subject: [PATCH 2/5] Add mamba python package update instruction --- doc/source/development/contributing_environment.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index f2a8880079367..12bdf524f51f1 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -98,6 +98,14 @@ Option 1: using mamba (recommended) mamba env create --file environment.yml mamba activate pandas-dev +* Ensure any python packages that do not have a version specified in the `environment.yml` file are + as up-to-date as possible: + +.. code-block:: none + + mamba activate pandas-dev + mamba update --all + .. _contributing.pip: Option 2: using pip From 6c3dc88741b9dea121ac3ad0ec9b5a4ac4b69c79 Mon Sep 17 00:00:00 2001 From: smij720 Date: Sun, 26 Nov 2023 18:39:57 -0800 Subject: [PATCH 3/5] Tidy --- doc/source/development/contributing_environment.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 12bdf524f51f1..8f73a327a10c6 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -98,8 +98,8 @@ Option 1: using mamba (recommended) mamba env create --file environment.yml mamba activate pandas-dev -* Ensure any python packages that do not have a version specified in the `environment.yml` file are - as up-to-date as possible: +* Ensure any python packages without a version specified in the ``environment.yml`` file + in the root directory are the most recent version: .. code-block:: none From 7e4fd15b26e76f7e38d5e60f2f02e92fbb3a35c9 Mon Sep 17 00:00:00 2001 From: smij720 <122238526+smij720@users.noreply.github.com> Date: Mon, 27 Nov 2023 21:30:58 -0800 Subject: [PATCH 4/5] Update doc/source/development/contributing_environment.rst Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com> --- doc/source/development/contributing_environment.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 8f73a327a10c6..34fef222c6074 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -87,9 +87,7 @@ Before we begin, please: Option 1: using mamba (recommended) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* Install `mamba `_ - (the instructions may direct you to install `miniforge `_, - which is OK - it includes mamba) +* Install miniforge to get `mamba `_ * Make sure your mamba is up to date (``mamba update mamba``) * Create and activate the ``pandas-dev`` mamba environment using the following commands: From cc368077585a6d27d8cc71f7003a7c00df2cf37f Mon Sep 17 00:00:00 2001 From: smij720 Date: Mon, 27 Nov 2023 21:35:01 -0800 Subject: [PATCH 5/5] Remove surplus instruction step --- doc/source/development/contributing_environment.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 34fef222c6074..325c902dd4f9e 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -96,14 +96,6 @@ Option 1: using mamba (recommended) mamba env create --file environment.yml mamba activate pandas-dev -* Ensure any python packages without a version specified in the ``environment.yml`` file - in the root directory are the most recent version: - -.. code-block:: none - - mamba activate pandas-dev - mamba update --all - .. _contributing.pip: Option 2: using pip