GenericMappingTools / GenericMappingTools/try-gmt

Binder repository for interactive GMT tutorials

Aperta
#19 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Jupyter Notebook
Stelle
58
Fork
20
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

**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](https://github.com/GenericMappingTools/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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando il tutorial esistente e l'esempio try-gmt, quindi analizza come Binder e JupyterLab potrebbero supportare tutorial per GMT, PyGMT, GMT.jl e gmtmex. Il lavoro sarà considerato completato quando saranno disponibili ambienti per i tutorial affidabili, riproducibili e pronti per Binder, che consentano agli utenti di imparare senza installazione locale e che completino la documentazione statica.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
julia, jupyter-notebook, python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.