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

Binder repository for interactive GMT tutorials #19

Open
maxrjones opened this issue Jan 7, 2021 · 4 comments
Open

Binder repository for interactive GMT tutorials #19

maxrjones opened this issue Jan 7, 2021 · 4 comments

Comments

@maxrjones
Copy link
Member

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

@seisman
Copy link
Member

seisman commented Jan 7, 2021

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?

@maxrjones
Copy link
Member Author

maxrjones commented Jan 7, 2021

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.

@gd-a
Copy link

gd-a commented Jan 12, 2021

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.

@maxrjones maxrjones transferred this issue from GenericMappingTools/gmt Mar 17, 2021
@maxrjones
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants