Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix installation instructions in the Contributing guide #2089

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −4
Open

Fix installation instructions in the Contributing guide #2089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca6943f
fix bugs in env creation of contribution guide
Hem-W Feb 27, 2025
a26668a
update changelog
Hem-W Feb 27, 2025
6337977
update changelog
Hem-W Feb 27, 2025
1eaa953
Update installation.rst removing explicit python version here too
aulemahal Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ Changelog

v0.56.0 (unreleased)
--------------------
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`).
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Hui-Min Wang (:user:`Hem-W`).

Bug fixes
^^^^^^^^^
* Fix installation instructions in the Contributing guide (:issue:`2088`, :pull:`2089`).

Breaking changes
^^^^^^^^^^^^^^^^
Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,9 @@ Ready to contribute? Here's how to set up `xclim` for local development.

.. code-block:: shell

conda create -n xclim python=3.10 --file=environment.yml
python -m pip install -e --no-deps .
conda env create --file environment.yml
conda activate xclim
python -m pip install -e . --no-deps

#. Create a branch for local development:

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ To create a conda environment including `xclim`'s dependencies and several optio

.. code-block:: console

conda env create -n my_xclim_env python=3.10 --file=environment.yml
conda env create -n my_xclim_env --file=environment.yml
conda activate my_xclim_env
(my_xclim_env) python -m pip install --no-deps -e .