add figpager as a third party package #18025

ebenp · 2020-07-22T18:51:57Z

PR Summary

I wrote a class around matplotlib's single and multi page backends to control subplot layout and some figure elements such s text, lines and images to make single and multi page figure templates. This PR adds links to this template library to the third party documentation page in matplotlib's documentation.

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way

story645 · 2020-07-22T18:56:20Z

please add Framework :: Matplotlib to the classifiers list in figpager's setup.py

ebenp · 2020-07-22T20:41:03Z

Thanks! :) I've updated setup.py
ebenp/figpager@245ab1d

jklymak

Thanks for adding this! You have a couple of formatting issues.

jklymak · 2020-07-23T01:45:48Z

doc/thirdpartypackages/index.rst

@@ -282,6 +282,14 @@ border, and logo.
 .. image:: /_static/mpl_template_example.png
    :height: 330px

+figpager
+=====


undescores must span the element above.

Thanks! I've extended them below.
ebenp@898e67f

jklymak · 2020-07-23T01:46:04Z

doc/thirdpartypackages/index.rst

+figpager
+=====
+
+`figpager <https://pypi.org/project/figpager/>`_ provides customizable figure elements such as text, lines and images


Please wrap at 79 char....

Thanks! I've wrapped it below.
ebenp@898e67f

Corrected heading and character wrap for figpager entry. Added period at sentence end.

timhoffm

We try to keep image sizes small. Please run the image though a png compressor like https://tinypng.com/.

ebenp · 2020-07-23T13:43:52Z

We try to keep image sizes small. Please run the image though a png compressor like https://tinypng.com/.

Thanks for thinking of the pixels! Thanks for linking to a compressor as well. I think I've updated things correctly.

Smaller image processed through tinypng and uploaded.
ebenp@f8d7f9a

Image path update in index.rst
ebenp@37a6fff#diff-688463b7d6617526f45f8caa3c0158c6

tacaswell

👍 This should be squashed to 1 commit (either by @ebenp or via squash-merge).

tacaswell · 2020-07-23T14:38:37Z

@ebenp you may also want to put in a JOSS (https://joss.theoj.org/) paper?

story645 · 2020-07-23T15:26:40Z

doc/thirdpartypackages/index.rst

-and subplot layout control for single or multi page output
+`figpager <https://pypi.org/project/figpager/>`_ provides 
+customizable figure elements such as text, lines and images
+and subplot layout control for single or multi page output.


and a subplot layout

This shaves off ~33% runtime from ```python from pylab import * import timeit tx = figtext(.5, .5, "foo\nbar baz") gcf().canvas.draw() gcf().patch.set_visible(False) r = gcf()._cachedRenderer n, t = timeit.Timer(lambda: tx.draw(r)).autorange(); print(t / n, n, t) ``` because previously the calls to realpath were not cached and filesystem access is slow. (The font cache is likely already in trouble if fonts move in the filesystem within the execution of a program given that there are other layers of cache, so I wouldn't overly worry about that. At best we may want to expose a manual function to invalidate all caches if someone really runs into that problem.)

jklymak · 2020-07-23T15:43:49Z

All these commits should be squashed before merging....

Fixes #18011.

author ebenp <4080051+ebenp@users.noreply.github.com> 1595519414 -0400 committer ebenp <4080051+ebenp@users.noreply.github.com> 1595520159 -0400 Added fgpager info

This reverts commit b1e514d, reversing changes made to a5c70ac.

ebenp · 2020-07-23T16:34:48Z

Ugh. Tried to squash / rebase and utterly failed. I kept getting newer matplotlib changes interspersed. Anyway, I nuked and paved by re forking and updating the files. How do I reset the link to the respoitory? HALP. :)

ebenp@1b783f1

jklymak · 2020-07-23T16:52:00Z

So sorry! I should have been more clear that you didn't need to do the squash if you weren't comfortable with the process.

ebenp · 2020-07-23T16:59:36Z

So sorry! I should have been more clear that you didn't need to do the squash if you weren't comfortable with the process.

Oh, no worries. I thought I could figure it out. I think I was close but my changes kept editing other files; init.py and font_manager and I got worried. For the future I'll ask from help in squashing. I assume I pull and then squash? Or do I squash my commits and don't worry about it being out of sync with the current matplotlib?

jklymak · 2020-07-23T17:07:25Z

I typically git rebase upstream/master, fix any conflicts, and then git log to see what the last commit on master is (say xxxx) and then do git rebase -i xxxx. https://matplotlib.org/3.3.0/devel/gitwash/index.html should go through this. If its not clear, let us know...

ebenp · 2020-07-23T17:11:29Z

I typically git rebase upstream/master, fix any conflicts, and then git log to see what the last commit on master is (say xxxx) and then do git rebase -i xxxx. https://matplotlib.org/3.3.0/devel/gitwash/index.html should go through this. If its not clear, let us know...

Thanks! That is super helpful. For this draft pull request is everything ok despite me removing the repository? Should I recreate the draft pull request or create a PR?

ebenp · 2020-07-23T17:12:04Z

@ebenp you may also want to put in a JOSS (https://joss.theoj.org/) paper?

Great idea! I'll have to come up with a spiffy logo!

timhoffm · 2020-07-23T17:13:49Z

Generally, you don't need to worry about syncing. The GitHub UI will tell you if there is a merge conflict. And only then you need to sync (by rebasing on top of master).

ebenp · 2020-07-23T17:19:16Z

Generally, you don't need to worry about syncing. The GitHub UI will tell you if there is a merge conflict. And only then you need to sync (by rebasing on top of master).

Ah ok. Yeah, I tried to be all fancy before I squashed through rebase and quickly was out of my depth. I won't worry about it in the future.

Thanks for the help and support all! This has been a really welcoming intro to matplotlib PRs.

ebenp · 2020-07-24T11:56:03Z

@story645 Let me know if there's a way to relink my repository or if I should create a new PR.

QuLogic · 2020-07-24T22:39:45Z

I don't think there is a way. Probably be best to create a new PR if this one is no longer updating correctly.

ebenp · 2020-07-25T13:17:01Z

Thanks! Sounds great. A new PR is here: #18059

ebenp added 2 commits July 22, 2020 14:33

Added fig pager demo file

64c7366

Added figpager info

5afe979

jklymak reviewed Jul 23, 2020

View reviewed changes

jklymak added the Documentation label Jul 23, 2020

Corrected formatting in figpager entry

898e67f

Corrected heading and character wrap for figpager entry. Added period at sentence end.

timhoffm requested changes Jul 23, 2020

View reviewed changes

ebenp added 3 commits July 23, 2020 09:38

Delete figpager_out_1.png

9c40ca5

Added smaller sized figpager png

f8d7f9a

Updated figpager image path

37a6fff

tacaswell added this to the v3.4.0 milestone Jul 23, 2020

tacaswell approved these changes Jul 23, 2020

View reviewed changes

story645 approved these changes Jul 23, 2020

View reviewed changes

anntzer and others added 4 commits July 23, 2020 11:32

Added figpager info

aadf3e2

Merge branch 'master' of https://github.com/ebenp/matplotlib

e799d5e

Update figpager.png

e767e03

QuLogic and others added 6 commits July 23, 2020 11:48

Fix flipped paths in non-writable config dir warning.

dd76c57

Fixes #18011.

Added figpager info

67246dc

Merge branch 'master' of https://github.com/ebenp/matplotlib

0969842

parent 548009c

a5c70ac

author ebenp <4080051+ebenp@users.noreply.github.com> 1595519414 -0400 committer ebenp <4080051+ebenp@users.noreply.github.com> 1595520159 -0400 Added fgpager info

Merge branch 'master' of https://github.com/ebenp/matplotlib

b1e514d

Revert "Merge branch 'master' of https://github.com/ebenp/matplotlib"

110f8f8

This reverts commit b1e514d, reversing changes made to a5c70ac.

ebenp closed this Jul 25, 2020

ebenp mentioned this pull request Jul 25, 2020

Added figpager info #18059

Merged

4 tasks

QuLogic added the status: duplicate label Mar 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add figpager as a third party package #18025

add figpager as a third party package #18025

ebenp commented Jul 22, 2020

story645 commented Jul 22, 2020 •

edited

Loading

ebenp commented Jul 22, 2020

jklymak left a comment

jklymak Jul 23, 2020

ebenp Jul 23, 2020

jklymak Jul 23, 2020

ebenp Jul 23, 2020

timhoffm left a comment

ebenp commented Jul 23, 2020

tacaswell left a comment

tacaswell commented Jul 23, 2020

story645 Jul 23, 2020

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

ebenp commented Jul 23, 2020

timhoffm commented Jul 23, 2020

ebenp commented Jul 23, 2020

ebenp commented Jul 24, 2020 •

edited

Loading

QuLogic commented Jul 24, 2020

ebenp commented Jul 25, 2020

add figpager as a third party package #18025

add figpager as a third party package #18025

Conversation

ebenp commented Jul 22, 2020

PR Summary

PR Checklist

story645 commented Jul 22, 2020 • edited Loading

ebenp commented Jul 22, 2020

jklymak left a comment

Choose a reason for hiding this comment

jklymak Jul 23, 2020

Choose a reason for hiding this comment

ebenp Jul 23, 2020

Choose a reason for hiding this comment

jklymak Jul 23, 2020

Choose a reason for hiding this comment

ebenp Jul 23, 2020

Choose a reason for hiding this comment

timhoffm left a comment

Choose a reason for hiding this comment

ebenp commented Jul 23, 2020

tacaswell left a comment

Choose a reason for hiding this comment

tacaswell commented Jul 23, 2020

story645 Jul 23, 2020

Choose a reason for hiding this comment

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

jklymak commented Jul 23, 2020

ebenp commented Jul 23, 2020

ebenp commented Jul 23, 2020

timhoffm commented Jul 23, 2020

ebenp commented Jul 23, 2020

ebenp commented Jul 24, 2020 • edited Loading

QuLogic commented Jul 24, 2020

ebenp commented Jul 25, 2020

story645 commented Jul 22, 2020 •

edited

Loading

ebenp commented Jul 24, 2020 •

edited

Loading