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

NetworKit graph I/O tutorial with Jupyter-Notebook #390

Merged
merged 5 commits into from
Sep 3, 2019

Conversation

cndolo
Copy link
Collaborator

@cndolo cndolo commented Jul 29, 2019

This PR introduces a new of Jupyter-Notebook for I/O of graphs with NetworKit. The goal is to improve the accessibility of NetworKit for new users. The following are the key points addressed in this PR:

  • Update of the existing User-Guide Notebook . Some example
  • The NetworkitBinaryGraph format is exposed to python. This was particularly necessary in order to explain to users how to use the NetworkitBinaryGraphReader/NetworkitBinaryGraphWriter in Python.
  • Introduce a new Notebook that covers the basics of I/O in NetworKit. Two new input graphs were necessary for the NetworkitBinaryGraph and ThrillBinaryGraph Format. The READMEinnetworkit/input` has been updated accordingly.
  • Add automated tests to ensure the notebooks are always functional.

@cndolo cndolo changed the title I/O notebook NetworKit graph I/O tutorial with Jupyter-Notebook Jul 29, 2019
@cndolo cndolo force-pushed the IONotebook branch 4 times, most recently from 5402140 to 4f22e2e Compare August 6, 2019 07:38
@avdgrinten
Copy link
Contributor

Some tests still fail due to missing packages. Your test script uses nbconvert and nbformat; both of these packages are available from PyPI (nbconvert, nbformat). You can add them to the pip3 install command in .travis.yml.

appveyor.yml Outdated Show resolved Hide resolved
input/README.md Outdated
@@ -24,6 +24,8 @@ This folder contains many smaller graphs. They are used in the testing suite and
| example.graph | Format.METIS | METISGraphReader | 16 | 4 | 2 | FALSE | FALSE | n/a |
| example2.dgs | n/a | DGSReader | 161 | n/a | n/a | n/a | n/a | n/a |
| foodweb-baydry.konect | Format.KONECT | KONECTGraphReader | 42847 | 128 | 2137 | TRUE | TRUE | n/a |
| foodweb-baydry.thrill | Format.THRILL | ThrillGraphReader | 410318 | 128 | 2137 | TRUE | TRUE | n/a |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trill file is very large (400 KiB). I don't exactly see why (@michitux ?) Can you take a smaller graph as an example?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have.

@angriman
Copy link
Member

angriman commented Sep 3, 2019

Thank you for addressing the comments. It looks like that in the "snap file format" section there is a problem. The text after "The format is..." does not seem to be very helpful, could that be a rendering issue? Try to use some different characters.
Apart from that, the PR looks good to me.

@cndolo
Copy link
Collaborator Author

cndolo commented Sep 3, 2019

It was a rendering issue; I have fixed it now.

@avdgrinten
Copy link
Contributor

@angriman Is this notebook in a good state now?

@angriman
Copy link
Member

angriman commented Sep 3, 2019

@avdgrinten Yes, just waiting for CI to finish to approve.

Copy link
Member

@angriman angriman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@avdgrinten avdgrinten merged commit 9880db3 into networkit:Dev Sep 3, 2019
@cndolo cndolo deleted the IONotebook branch September 3, 2019 11:55
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

Successfully merging this pull request may close these issues.

None yet

3 participants