Frequently Asked Questions (FAQ) draft

[jukrb0x]

Which part of the documentation is missing/unclear?

Frequently Asked Questions (FAQ) draft here.

FAQ

These are example questions.

1. What is Graphery?

2. How do I use it?

3. How to run my own code on Graphery?

4. I found a bug, how to report it?

5. Can I make contributions to Graphery?

[annaritz]

Those questions are great for now! The answers can be brief too. I'd add a line at the bottom to direct any more questions to graphery@groups.reed.edu.

Where will this be linked from? I'd suggest the Home page and the About page.

[jukrb0x]

Those questions are great for now! The answers can be brief too. I'd add a line at the bottom to direct any more questions to graphery@groups.reed.edu.

Where will this be linked from? I'd suggest the Home page and the About page.

I've add linkd on the bottom of pages with footer(like Home, Tutorials, About..), but put it on prominent places is great, say buttons or highlighted texts on the home page and about page. We will work on that!

[annaritz]

Note: links are currently broken. Please add in as you update the FAQ on the website. Thanks!

What is Graphery?

Graphery is a platform with interactive tutorials about graph algorithms alongside real-world biological networks. It is designed with biological researchers in mind, where users can click through Python code and see how the algorithms work on networks from different biological domains.

How do I use it?

If you want a tour of the platform take the first tutorial: Getting Started. This is the best place to start! The other tutorials are available on the [Tutorials] tab. If you want to see the networks that are offered, click the Graphs tab. If you click a graph, you are taken to a playground view where you can interact with the graph, run the code associated with tutorials.

How to run my own code on Graphery?

You can execute existing code in the cloud by clicking [insert cloud button] on the editor. If you click [insert unlock button] , you will change the user settings so you can modify existing code or write your own code. Click [insert cloud button] whenever you want the code to run.

If you would like to run your code locally on your machine (instead of in the cloud), instructions are available here.

I found a bug, how to report it?

Please file a GitHub Issue - thanks in advance!

Can I make contributions to Graphery?

Yes! If you have an idea for a graph or a tutorial, then file a GitHub Issue. If you would like to add content to the website, we are always looking for contributors to add graphs, tutorials, and translations. [Email us to learn more](email link).

How do I cite Graphery?

Graphery is currently under review. In the meantime, please cite our pre-print on arXiv:

Heyuan Zeng, Jinbiao Zhang, Gabriel A. Preising, Tobias Rubel, Pramesh Singh, Anna Ritz.
Graphery: Interactive Tutorials for Biological Network Algorithms
arXiv:2102.03469 [q-bio.MN], 2021

[FlickerSoul]

Got it.