-
Notifications
You must be signed in to change notification settings - Fork 224
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
Conversation
/format |
Two notes:
|
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: I reduced the size of my image via the tool @seisman mentioned and now it is 140 KB large. |
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. |
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. |
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). |
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. |
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%"} |
There was a problem hiding this comment.
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%"} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
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 |
Description of proposed changes
List the PyGMT talk at AGU24 to the "Overview" section
- Orientation on existing thumbnails, used a photo @weiji14 made
- Better link to an image, to avoid including large files into the repo
- http://dx.doi.org/10.6084/m9.figshare.28049495
- Recordings are not freely available, do not include an image of the presenter, and are not linked with the slides
- https://www.researchgate.net/publication/387127897_PyGMT_-_Accessing_and_Integrating_GMT_with_Python_and_the_Scientific_Python_Ecosystem
Preview: https://pygmt-dev--3685.org.readthedocs.build/en/3685/overview.html
Fixes: #3683 (partly)
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code