try-gmt icon indicating copy to clipboard operation
try-gmt copied to clipboard

Binder repository for interactive GMT tutorials

Open maxrjones opened this issue 5 years ago • 4 comments

Description of the desired feature

A large part of the NASA proposal that we’re working on involves improving the GMT documentation, including tutorials. One goal is to make the tutorials reliably repeatable and fully reproducible. Remote files will be useful for this purpose, which are already used in the existing tutorial but not some other parts of the documentation. In addition, it would be great for people to be able to learn GMT, PyGMT, GMT.jl, and/or gmtmex without needing to go through the installation steps. My expectation is that Binder and JupyterLab environments would be an excellent way to ensure that the tutorials are reliably repeatable. The result would be similar to try-gmt. The binder-ready repos would complement static versions of the tutorials in the docs that users could follow in their local environments. Pinging @GenericMappingTools/core, @GenericMappingTools/gmt-contributors, @GenericMappingTools/python, and @GenericMappingTools/python-maintainers for opinions about whether this is worthwhile.

I am also to happy to chat in more detail about other documentation improvements included in the proposal, so please feel free to reach out. Slack is probably the easiest medium for a broader conversation about the proposal.

Are you willing to help implement and maintain this feature? Yes

maxrjones avatar Jan 07 '21 16:01 maxrjones

We already have a bash demo in try-gmt. Could we just add more tutorials in the try-gmt binder, so that we don't have to maintain two similar environments?

seisman avatar Jan 07 '21 20:01 seisman

We already have a bash demo in try-gmt. Could we just add more tutorials in the try-gmt binder, so that we don't have to maintain two similar environments?

Yes, it might be easiest to create Jupyter Notebooks for the tutorials and include them in the try-gmt environment.

maxrjones avatar Jan 07 '21 22:01 maxrjones

May I (also) suggest an easy/clear access to the remote files. It's not always easy to find where or what the files are.

gd-a avatar Jan 12 '21 21:01 gd-a

Moved this issue over to the try-gmt repo, since the tutorials would be hosted in the same environment.

maxrjones avatar Mar 17 '21 20:03 maxrjones