Skip to content

Add histogram gallery example - #1272

Merged
weiji14 merged 16 commits into
masterfrom
gallery-histogram
May 18, 2021
Merged

Add histogram gallery example#1272
weiji14 merged 16 commits into
masterfrom
gallery-histogram

Conversation

@michaelgrund

@michaelgrundmichaelgrund commented May 12, 2021•
edited by weiji14
Loading

Copy link
Copy Markdown
Member

Description of proposed changes

Since histogram is now wrapped in #1072, here's a corresponding gallery example.

Preview at https://pygmt-git-gallery-histogram-gmt.vercel.app/gallery/histograms/histogram.html

Histogram gallery example

I guess we should also add the v3206_06.txt remote file to the cache data, right?

This is continuation of work on #563.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@michaelgrundmichaelgrund added the documentation Improvements or additions to documentation label May 12, 2021
@michaelgrundmichaelgrund added this to the 0.4.0 milestone May 12, 2021
@michaelgrund
michaelgrund marked this pull request as draft May 12, 2021 16:42
@michaelgrund
michaelgrund marked this pull request as ready for review May 12, 2021 17:03
@seisman

seisman commented May 13, 2021

Copy link
Copy Markdown
Member

I guess we should also add the v3206_06.txt remote file to the cache data, right?

Perhaps we should just generate some random data like this one https://matplotlib.org/stable/gallery/statistics/histogram_features.html.

@michaelgrund

michaelgrund commented May 13, 2021

Copy link
Copy Markdown
MemberAuthor

I guess we should also add the v3206_06.txt remote file to the cache data, right?

Perhaps we should just generate some random data like this one https://matplotlib.org/stable/gallery/statistics/histogram_features.html.

Of course, would be also fine for me.

seisman
seisman reviewed May 13, 2021
View reviewed changes
Comment threadexamples/gallery/histograms/histogram.py Outdated
Comment threadexamples/gallery/histograms/histogram.py Outdated
@michaelgrund@seisman
Apply suggestions from code review
29f8b21
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman

seisman commented May 13, 2021•
edited
Loading

Copy link
Copy Markdown
Member

The example looks good to me, but I'm wondering if we should change the parameter type to histtype, because type is a Python's built-in method.

FYI, GMT.jl uses kind and matplotlib uses histtype.

Ping @willschlitzer

@michaelgrund

michaelgrund commented May 14, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

The example looks good to me, but I'm wondering if we should change the parameter type to histtype, because type is a Python's built-in method.

FYI, GMT.jl uses kind and matplotlib uses histtype.

Ping @willschlitzer

Agree with @seisman since type is always highighted as Python built-in method in Jupyter as well as any IDE. Will open an separate PR to change it.

michaelgrund added a commit that referenced this pull request May 14, 2021
@michaelgrund
Rename Z alias in histogram
0f912b3
As discussed in #1272 the alias for Z should be renamed since ``type`` is already used as Python built-in method.
@michaelgrundmichaelgrund mentioned this pull request May 14, 2021
Merged
5 tasks
weiji14
weiji14 reviewed May 15, 2021
View reviewed changes
Comment threadexamples/gallery/histograms/histogram.py Outdated
Comment threadexamples/gallery/histograms/histogram.py Outdated
Comment threadexamples/gallery/histograms/histogram.py Outdated
michaelgrund
michaelgrund commented May 15, 2021
View reviewed changes

@michaelgrundmichaelgrund left a comment

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the comments and suggestions @weiji14.

michaelgrundand others added 2 commits May 15, 2021 10:23
@michaelgrund@weiji14
Apply suggestions from code review
af29985
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@michaelgrund
Merge branch 'master' into gallery-histogram
22f2b2c
@seismanseisman added the final review call This PR requires final review and approval from a second reviewer label May 15, 2021
seisman
seisman approved these changes May 15, 2021
View reviewed changes

@seismanseisman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

willschlitzer
willschlitzer approved these changes May 16, 2021
View reviewed changes

@willschlitzerwillschlitzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

weiji14
weiji14 reviewed May 16, 2021
View reviewed changes
Comment threadexamples/gallery/histograms/histogram.py
core-man
core-man reviewed May 16, 2021
View reviewed changes
Comment threadexamples/gallery/histograms/histogram.py Outdated
core-man
core-man approved these changes May 17, 2021
View reviewed changes

@core-mancore-man left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great~

weiji14
weiji14 reviewed May 17, 2021
View reviewed changes
Comment threadexamples/gallery/histograms/histogram.py Outdated
@michaelgrund@weiji14
Update examples/gallery/histograms/histogram.py
cb18764
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
weiji14
weiji14 approved these changes May 18, 2021
View reviewed changes

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@weiji14
weiji14 self-requested a review May 18, 2021 11:25
@weiji14
weiji14 merged commit 5125224 into masterMay 18, 2021
@weiji14
weiji14 deleted the gallery-histogram branch May 18, 2021 11:32
@weiji14weiji14 removed the final review call This PR requires final review and approval from a second reviewer label May 23, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@michaelgrund@seisman
@weiji14@willschlitzerJosh Sixsmith
Add histogram gallery example (GenericMappingTools#1272)
3266e4c
Gallery example of a histogram with red bars on a gray background.
Elevation counts are binned at 5m intervals, and the data is
generated from a normal distribution with random noise added.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Will Schlitzer <schlitzer90@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes
@willschlitzerwillschlitzerwillschlitzer approved these changes
@core-mancore-mancore-man approved these changes
@weiji14weiji14Awaiting requested review from weiji14

Assignees

@michaelgrundmichaelgrund

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

0.4.0

Development

Successfully merging this pull request may close these issues.

5 participants

@michaelgrund@seisman@weiji14@willschlitzer@core-man