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

WIP: List the PyGMT talk at AGU24 in the "Overview" section | Keep large thumbnail images for "Overview" section ? #3685

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Dec 12, 2024

Description of proposed changes

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

  • Create and add thumbnail image (orientation on existing thumbnails, used a photo @weiji14 made)
  • Upload slides and add URL / DOI (recordings are not freely available, do not include an image of the presenter, and are not linked with the slides)
  • Upload abstract to ResearchGate

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
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussions Need more discussion before taking further actions maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants