Skip to content

Followup documentation for petroff color sequence #28750

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 2 tasks
tacaswell opened this issue Aug 22, 2024 · 30 comments
Open
1 of 2 tasks

Followup documentation for petroff color sequence #28750

tacaswell opened this issue Aug 22, 2024 · 30 comments
Labels
Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!

Comments

@tacaswell
Copy link
Member

tacaswell commented Aug 22, 2024

This can be done in a followup, but would be nice if this got added to the following for discoverability:

* https://matplotlib.org/devdocs/users/explain/colors/colormaps.html
* https://matplotlib.org/devdocs/gallery/color/colormap_reference.html#sphx-glr-gallery-color-colormap-reference-py

ETA: also I'm really psyched this is going in, thanks for your work on this folks!

Originally posted by @story645 in #27851 (review)

@tacaswell tacaswell added this to the v3.10.0 milestone Aug 22, 2024
@story645 story645 added the Good first issue Open a pull request against these issues if there are no active ones! label Aug 22, 2024
Copy link

Good first issue - notes for new contributors

This issue is suited to new contributors because it does not require understanding of the
Matplotlib internals. To get started, please see our contributing
guide
.

We do not assign issues. Check the Development section in the sidebar for linked pull
requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please
collaborate on the work by reviewing it rather than duplicating it in a competing PR.

If something is unclear, please reach out on any of our communication
channels
.

@story645
Copy link
Member

Good first issue b/c minimally it's adding one string petroff10 to the appropriate listing of colormaps in each of the pages listed above.

@tacaswell
Copy link
Member Author

But we added these as color sequences not as categorical color maps.

@story645
Copy link
Member

But we added these as color sequences not as categorical color maps

For some reason I thought we'd moved all the categoricals to color sequences, but if not then this issue should be to create user documentation/ a new user guide page for the color sequence registry and using it b/c that doesn't really exist.

It's still an ok first issue b/c it's fairly standalone -> new page in colors section of user guide -> but more work.

@story645 story645 added the Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues label Aug 22, 2024
@tacaswell
Copy link
Member Author

@story645 Can you either edit the initial post or leave a comment with details about what you have in mind?

@tacaswell
Copy link
Member Author

I think we made all of the discrete color maps available as sequences, but did not remove them as color maps. With petroff10 we did not also add it as a colormap (maybe someone will ask for that, but I think we should hold off on doing it until there is actually a demand).

@Harish-2003
Copy link

is this issue still open can i work on it?

@story645
Copy link
Member

Yes, this documentation hasn't been created yet and you're welcome to create it.

@Harish-2003
Copy link

Harish-2003 commented Aug 29, 2024

May I know what is petroff10

@story645
Copy link
Member

May I know what is petroff10

'petroff10' is the matplotlib name for the new color Petroff color sequence and how it is accessed in code.

@Nikhil172913832
Copy link

Hey, is the issue still open, would love to contribute?

@matthewfeickert
Copy link
Contributor

matthewfeickert commented Sep 8, 2024

Note that issues don't get assigned or claimed: https://matplotlib.org/devdocs/devel/contribute.html#work-on-an-issue

Work on an issue
================
In general, the Matplotlib project does not assign issues. Issues are
"assigned" or "claimed" by opening a PR; there is no other assignment
mechanism. If you have opened such a PR, please comment on the issue thread to

So go for it. 👍 Though reading the contributing docs (https://matplotlib.org/devdocs/devel/contribute.html) is a good first step.

@ammar-qazi
Copy link
Contributor

I was trying to set up a dev environment for matplotlib. Finally, figured it out: had to switch from Windows to Linux. So, I'll working on this issue now.

@hwii-florescent
Copy link

Is the issue still opened? I want to contribute to it

@ammar-qazi
Copy link
Contributor

@hwii-florescent Yeah, I worked on the first task. You can get started on the second task:

add a page explaining the color sequences to https://matplotlib.org/devdocs/users/explain/colors/index.html

@Nikhil172913832
Copy link

I am willing to take on the second task. Could you provide more context on what exactly needs to be done?

@ammar-qazi
Copy link
Contributor

Here's my understanding.

The page the second task links to has this in its description

Colors

Matplotlib has support for visualizing information with a wide array of colors and colormaps. These tutorials cover the basics of how these colormaps look, how you can create your own, and how you can customize colormaps for your use case.

For even more information see the examples page.

As of now, the page doesn't explore the color sequences — as in how you can customize the color maps and make your information more accessible by using different style sheets.

So, if we have a separate page for that, it would be helpful to Matplotlib users.

That's all I know.

@u7228810
Copy link

Hello, is this issue completed yet? Am I able to work on it as my first issue - maybe finish off what others left if its still open?

@ammar-qazi
Copy link
Contributor

@u7228810 Yes, the second task hasn't been attempted yet.

That said, if it's your very first contribution, I would suggest starting with a difficulty: easy task.

@timhoffm timhoffm modified the milestones: v3.10.0, v3.11.0, future releases Oct 21, 2024
@scottshambaugh
Copy link
Contributor

we added these as color sequences not as categorical color maps

FWIW I'm clueless on the difference, I thought that the listings on this page were exhaustive! https://matplotlib.org/devdocs/users/explain/colors/colormaps.html

Unclear to me how to use this new coloring without changing the whole style sheet.

@timhoffm
Copy link
Member

timhoffm commented Oct 28, 2024

We have both

  • colormaps in the ColorMapRegistry mpl.colormaps / plt.colormaps: mapping a numeric interval [0, 1] to colors.
  • color sequences in the ColorSequenceRegistry mpl.color_sequences / plt.color_sequences: named lists of colors

Example usages:

ax.set_prop_cycle(color=plt.color_sequences['petroff10'])
ax.stackplot([0, 1], [[0, 1], [0, 2], [0, 3]], colors=plt.color_sequences['petroff10'])

@SHRISHTISHUKLA-0
Copy link

SHRISHTISHUKLA-0 commented Jan 30, 2025

@ammar-quzi Hello does Second task still open ?? pls let me know
am looking for good first issue.

@ammar-qazi
Copy link
Contributor

@SHRISHTISHUKLA-0 Yes, the second task is still open.

@SHRISHTISHUKLA-0
Copy link

SHRISHTISHUKLA-0 commented Jan 30, 2025 via email

@SHRISHTISHUKLA-0
Copy link

SHRISHTISHUKLA-0 commented Jan 30, 2025 via email

@story645
Copy link
Member

story645 commented Jan 30, 2025

"add a page explaining the color sequences to https://matplotlib.org/devdocs/users/explain/colors/index.html"

Color sequences are named lists of colors that can be used for style sheets, cycler objects and as lists of colors. colors/index is the section of the docs that explains colors and it's missing a page on sequences.

If you've never worked with color sequences or don't see a need to, then you may not have the context necessary for writing this documentation.

@SHRISHTISHUKLA-0
Copy link

"add a page explaining the color sequences to https://matplotlib.org/devdocs/users/explain/colors/index.html"

Color sequences are named lists of colors that can be used for style sheets, cycler objects and as lists of colors. colors/index is the section of the docs that explains colors and it's missing a page on sequences.

If you've never worked with color sequences or don't see a need to, then you may not have the context necessary for writing this documentation.

hello I think that I can able to solve this is but here I can't able to link PR why?

@SHRISHTISHUKLA-0
Copy link

@SHRISHTISHUKLA-0 Yes, the second task is still open.

please tell me why I am not able to get PR link after push ??
its showing error ( remote: permission to matplotlib/matplotlib.git denied to SHRISHTISHUKLA-0 fatal: unable to access 'http://github.com/matplotlib/matplotlib.git/'.The requested URL returned error: 403

what should I do now??

@WeatherGod
Copy link
Member

WeatherGod commented Jan 31, 2025 via email

@SHRISHTISHUKLA-0
Copy link

The error message indicates that you are trying to push to matplotlib's
repository rather than your fork. Make sure you follow the developer
guidance to help you get started:
https://matplotlib.org/devdocs/devel/development_workflow.html

ooh thank you as firstyear student first time I'm contributing in open sources and pr that's why I having lot of doubts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Development

No branches or pull requests