Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.1k
Add conda env to setup instructions#23435
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -4,12 +4,33 @@ | ||||||||
| Setting up Matplotlib for development | ||||||||
| ===================================== | ||||||||
| Retrieving the latest version of the code | ||||||||
| ========================================= | ||||||||
| Matplotlib is hosted at https://github.com/matplotlib/matplotlib.git. | ||||||||
| You can retrieve the latest sources with the command (see | ||||||||
| :ref:`set-up-fork` for more details):: | ||||||||
| git clone https://github.com/matplotlib/matplotlib.git | ||||||||
| This will place the sources in a directory :file:`matplotlib` below your | ||||||||
| current working directory. | ||||||||
| If you have the proper privileges, you can use ``git@`` instead of | ||||||||
| ``https://``, which works through the ssh protocol and might be easier to use | ||||||||
| if you are using 2-factor authentication. | ||||||||
Comment on lines +20 to +22 Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
No one should be pushing directly to the upstream fork (even if they can) as we do all work through PRs from individual forks. Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Let's put that change into#23588? Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Sounds good to me. | ||||||||
| .. _dev-environment: | ||||||||
| Creating a dedicated environment | ||||||||
| ================================ | ||||||||
| You should set up a dedicated environment to decouple your Matplotlib | ||||||||
| development from other Python and Matplotlib installations on your system. | ||||||||
| Using virtual environments | ||||||||
| -------------------------- | ||||||||
| Here we use python's virtual environment `venv`_, but you may also use others | ||||||||
| such as conda. | ||||||||
| @@ -28,22 +49,27 @@ and activated with one of the following:: | ||||||||
| Whenever you plan to work on Matplotlib, remember to activate the development | ||||||||
| environment in your shell. | ||||||||
| Conda dev environment | ||||||||
| --------------------- | ||||||||
| After you have cloned the repo change into the matplotlib directory. | ||||||||
| A new conda environment can be set-up with:: | ||||||||
| conda env create -f environment.yml | ||||||||
| Note that if you have mamba installed you can replace conda with mamba in | ||||||||
| the above command. | ||||||||
| To activate your environment:: | ||||||||
| conda activate mpl-dev | ||||||||
| Finish the install by the following command:: | ||||||||
| pip install -e . | ||||||||
| Whenever you plan to work on Matplotlib, remember to ``conda activate mpl-dev`` | ||||||||
| in your shell. | ||||||||
| Installing Matplotlib in editable mode | ||||||||
| ====================================== | ||||||||