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.

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

Add the PyGMT talk at AGU24 to the "Overview" section #3685

Merged
merged 22 commits into from
Dec 23, 2024
Merged

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Dec 12, 2024

Description of proposed changes

List the PyGMT talk at AGU24 to the "Overview" section

Preview: https://pygmt-dev--3685.org.readthedocs.build/en/3685/overview.html

Fixes: #3683 (partly)

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the maintenance Boring but important stuff for the core devs label Dec 12, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Dec 12, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Dec 12, 2024
@yvonnefroehlich yvonnefroehlich marked this pull request as draft December 12, 2024 14:55
@yvonnefroehlich yvonnefroehlich changed the title WIP: Add PyGMT talk at AGU24 to "overview" section WIP: List the PyGMT and GMT contribution to AGU24 to the PyGMT documentation Dec 12, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: List the PyGMT and GMT contribution to AGU24 to the PyGMT documentation WIP: List the PyGMT and GMT contributions to AGU24 to the PyGMT documentation Dec 12, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: List the PyGMT and GMT contributions to AGU24 to the PyGMT documentation WIP: List the PyGMT and GMT contributions to AGU24 in the PyGMT documentation Dec 12, 2024
@yvonnefroehlich
Copy link
Member Author

/format

@seisman
Copy link
Member

seisman commented Dec 13, 2024

Two notes:

  1. @maxrjones once proposed to move all presentations to the "External Resources" and had some ideas about what to be included in the overview page (Remove Liam's talk from the overview page #1764 (comment)). I'm unsure if @maxrjones still remembers the ideas.

  2. As previously mentioned in Add SciPy 2022 talk to presentations #2053 (comment), I feel we should not add large binary files/images into this repository. Even if we decide to add, we should compress the image using tools like https://squoosh.app/

@yvonnefroehlich yvonnefroehlich changed the title WIP: List the PyGMT and GMT contributions to AGU24 in the PyGMT documentation WIP: List the PyGMT talk at AGU24 in the PyGMT documentation Dec 13, 2024
@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Dec 13, 2024

  1. As previously mentioned in Add SciPy 2022 talk to presentations #2053 (comment), I feel we should not add large binary files/images into this repository. Even if we decide to add, we should compress the image using tools like https://squoosh.app/

Hm. I also was a bit wondering about the sizes of the image files. But when comparing the image added newly in the PR with the already included images, the file size is in the same range:
overview_images_size

I reduced the size of my image via the tool @seisman mentioned and now it is 140 KB large.

@yvonnefroehlich
Copy link
Member Author

  1. @maxrjones once proposed to move all presentations to the "External Resources" and had some ideas about what to be included in the overview page (Remove Liam's talk from the overview page #1764 (comment)). I'm unsure if @maxrjones still remembers the ideas.

Yes, adding the conference contributions to the “overview” section is not directly intuitive. But maybe the idea of adding these materials to the overview page was to show how the PyGMT project developed over time (instead of any kind of history section). Some of these contributions are more an overview of the main ideas and aims of the project rather than a more detailed presentation on PyGMT.

@seisman
Copy link
Member

seisman commented Dec 13, 2024

  1. As previously mentioned in Add SciPy 2022 talk to presentations #2053 (comment), I feel we should not add large binary files/images into this repository. Even if we decide to add, we should compress the image using tools like https://squoosh.app/

Hm. I also was a bit wondering about the the sizes of the image files. But when comparing the image added newly in the PR with the already included images, the file size is in the same range: overview_images_size

I reduced the size of my image via the tool @seisman mentioned and now it is 140 KB large.

These large images were added at the very early stage of the project and I think that's not a good practice.

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Dec 14, 2024

These large images were added at the very early stage of the project and I think that's not a good practice.

Then we probably have to discuss / decide if we want to keep / continue the list of conference contributions as is or remove these images from the repo. Or we find a solution where we can just link to an image which serves as thumbnail image.

@yvonnefroehlich yvonnefroehlich changed the title WIP: List the PyGMT talk at AGU24 in the PyGMT documentation WIP: List the PyGMT talk at AGU24 in the "Overview" section Dec 14, 2024
@yvonnefroehlich yvonnefroehlich added the discussions Need more discussion before taking further actions label Dec 14, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: List the PyGMT talk at AGU24 in the "Overview" section WIP: List the PyGMT talk at AGU24 in the "Overview" section | Keep large thumbnail images for "Overview" section ? Dec 14, 2024
@weiji14
Copy link
Member

weiji14 commented Dec 16, 2024

Or we find a solution where we can just link to an image which serves as thumbnail image.

If you are planning to upload your slides to Figshare or ResearchGate to create a DOI, you can also upload the thumbnail image there, and we can link to that instead of uploading the thumbnail to the PyGMT repo?

@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 16, 2024
49 tasks
@yvonnefroehlich
Copy link
Member Author

Or we find a solution where we can just link to an image which serves as thumbnail image.

If you are planning to upload your slides to Figshare or ResearchGate to create a DOI, you can also upload the thumbnail image there, and we can link to that instead of uploading the thumbnail to the PyGMT repo?

I added the title and summery slides as figures on RG (https://www.researchgate.net/publication/387127897_PyGMT_-_Accessing_and_Integrating_GMT_with_Python_and_the_Scientific_Python_Ecosystem/figures) and linked the title slide for the overview section in the PyGMT docs (commit 262d6d4).

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Dec 18, 2024

In commit 8ffb788, I tried to link to the thumbnail images provided by figshare. In principle this works, however the resolution is quite poor. In commit 12dd4fb, I reduced the width of the images to see if this helps.

This would be a way to be able to remove the large images stored in the repo, except "doc/_static/scipy2022-youtube-thumbnail.jpg", as this one is also used in the README.

@seisman
Copy link
Member

seisman commented Dec 19, 2024

The easiest solution is to upload the static images into the comment box, and then GitHub will store them for us, just like what we're doing in https://github.com/GenericMappingTools/pygmt/blob/main/doc/external_resources.md,

doc/overview.md Outdated
- "Geospatial Analysis & Visualization with PyGMT".
2022.
Max Jones, Wei Ji Leong, and Leonardo Uieda.
Presented at *SciPy 2022*.
doi:[10.6084/m9.figshare.20483793](https://doi.org/10.6084/m9.figshare.20483793)

![](_static/scipy2022-youtube-thumbnail.jpg){.align-center width="80%"}
![](https://s3-eu-west-1.amazonaws.com/pfigshare-u-previews/36664998/thumb.png){.align-center width="50%"}
Copy link
Member

Choose a reason for hiding this comment

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

For the images files 2022 and older, they have already been commited to the git history, so removing them won't actually reduce the download size when doing a git clone. So you can revert the changes here and in the lines below.

doc/overview.md Outdated
Presented at *AGU 2024*.
doi:[10.6084/m9.figshare.28049495](https://doi.org/10.6084/m9.figshare.28049495)

![](https://s3-eu-west-1.amazonaws.com/pfigshare-u-previews/51279815/thumb.png){.align-center width="50%"}
Copy link
Member

Choose a reason for hiding this comment

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

The easiest solution is to upload the static images into the comment box, and then GitHub will store them for us, just like what we're doing in https://github.com/GenericMappingTools/pygmt/blob/main/doc/external_resources.md,

I use this trick all the time too, but I'm never sure how stable this actually is. What I'd recommend is to upload the full resolution thumbnail image to figshare (see e.g. how I uploaded a PNG thumbnail and PDF version of my MIGARS poster) just in case. We can still use the GitHub link, but if that image ever disappears accidentally, we can retrieve it from figshare again.

Copy link
Member

Choose a reason for hiding this comment

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

What I'd recommend is to upload the full resolution thumbnail image to figshare (see e.g. how I uploaded a PNG thumbnail and PDF version of my MIGARS poster) just in case. We can still use the GitHub link, but if that image ever disappears accidentally, we can retrieve it from figshare again.

Or we can create a separate github repository to store these static images.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe merge this PR and open a separat issue (and PR) for this?

Copy link
Member

Choose a reason for hiding this comment

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

yes, we can discuss it later

Copy link
Member Author

Choose a reason for hiding this comment

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

I opened issue to not forget about this #3708.

@yvonnefroehlich
Copy link
Member Author

The easiest solution is to upload the static images into the comment box, and then GitHub will store them for us, just like what we're doing in https://github.com/GenericMappingTools/pygmt/blob/main/doc/external_resources.md,

Actually, I tried this directly at the beginning of this PR in commit c7c3228. But for me, the URL related to the image is not in the form https://user-images.githubusercontent.com/XYZ.png but in https://private-user-images.githubusercontent.com/XYZ.png?ABC. I remember that I faced this issue before, but could not figure out what I have to change on my side.

@seisman
Copy link
Member

seisman commented Dec 19, 2024

agu2024_talk

Here is the link that can be used: https://github.com/user-attachments/assets/19e1391e-648d-43da-b6f6-ecfb4f3e83e8

@seisman seisman added documentation Improvements or additions to documentation and removed discussions Need more discussion before taking further actions maintenance Boring but important stuff for the core devs labels Dec 19, 2024
@seisman seisman changed the title WIP: List the PyGMT talk at AGU24 in the "Overview" section | Keep large thumbnail images for "Overview" section ? Add the PyGMT talk at AGU24 in the "Overview" section Dec 19, 2024
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 19, 2024
@yvonnefroehlich yvonnefroehlich changed the title Add the PyGMT talk at AGU24 in the "Overview" section Add the PyGMT talk at AGU24 to the "Overview" section Dec 22, 2024
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review December 22, 2024 23:22
@seisman seisman merged commit 5a3a290 into main Dec 23, 2024
11 checks passed
@seisman seisman deleted the add-agu24-content branch December 23, 2024 02:26
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants