Das Julia Language-Projekt

Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:

Die Programmiersprache Julia

Technischer Redakteur:

Shuo Liu

Projektname:

LightGraphs Docs 2.0 und nutzerfreundliche JuliaGraphs-Anleitungen

Projektdauer:

Lang andauernd (5 Monate)

Projektbeschreibung

In diesem lang andauernden Projekt werde ich die Website und die Dokumentation der Module in JuliaGraphs verbessern. Insbesondere umfasst meine Arbeit die folgenden Inhalte:

LightGraphs Docs 2.0 – 10 Wochen

• Übersicht: LightGraphs.jl ist ein optimiertes, schlankes Graphenpaket für Julia, das als Kern des JuliaGraphs-Ökosystems dient. Die anstehende Version 2.0 von LightGraphs stellt eine grundlegende Änderung der LightGraphs API dar. Ich werde dafür sorgen, dass die Dokumentation die neuesten und besten Funktionen von LightGraphs darstellt.
• Arbeitsergebnisse: Ich werde die vorhandenen API-Dokumente prüfen, um festzustellen, welche Dokumentation unverändert bleiben kann, und die Änderungen in der Version 2.0 analysieren, um sicherzustellen, dass sie mit Beispielen korrekt dokumentiert sind. Während dieses Prozesses werde ich Beiträge schreiben, in denen die wichtigsten Änderungen in der Version 2.0 hervorgehoben werden. Damit die Neueinsteiger die LightGraphs-Grafik besser verstehen, erstelle ich Leitfäden für Anfänger für alle, die ihren ersten Schritt in die Welt der Verwendung von Grafiken in Julia machen.
• Hinweise: In diesem Projekt wird Documenter.jl als Dokumentgenerator verwendet, um die LightGraphs-Dokumente zu erstellen. Neben API-Referenzen für Module wie Coloring.jl benötige ich sie auch für die Untermodule wie greedy_color.jl. Ich werde herausfinden, wie ich sie hinzufügen kann, um die LightGraphs-Dokumentation zu aktualisieren. Außerdem ist die Graphentheorie ein ziemlich technisches Gebiet der Mathematik und für Personen ohne mathematischen Hintergrund schwer verständlich. Ich habe etwa zwei Jahre lang akademische Forschung betrieben und viele Blogbeiträge auf meiner persönlichen Website verfasst. Daher bin ich zuversichtlich, dass ich die wichtigsten Aspekte verschiedener Algorithmen erläutern und Hinweise dazu geben kann, welche in verschiedenen Situationen verwendet werden sollten.

JuliaGraphs-Tutorials – 10 Wochen

• Übersicht: Viele der Dokumentationen der JuliaGraphs-Pakete sind auf Entwickler ausgerichtet. Ich werde einige einfache Beispiele hinzufügen und die Verwendung der einzelnen Funktionen veranschaulichen, um sie für Nutzer zugänglicher zu machen.
• Arbeitsergebnisse: Ich werde die vorhandenen LightGraphs-Anleitungen prüfen, um herauszufinden, welche Materialien hinzugefügt werden müssen, und die Verwendung und Motivation der einzelnen Funktionen demonstrieren. Dann werde ich in der Art und Weise von JuliaGraphsTutorials JuliaGraphs-Anleitungen erweitern, einschließlich eines Leitfadens für Anfänger im LightGraphs-System.
• Anmerkungen: Der Inhalt der JuliaGraphsTutorials ist derzeit nicht ausführlich genug. Die oben aufgeführten Liefergegenstände beziehen sich hauptsächlich auf das LightGraphs-Paket. Wenn es die Zeit erlaubt, füge ich auch Anleitungen für andere Module in JuliaGraphs hinzu, z. B. GraphPlot.jl, MetaGraphs.jl und SimpleWeightedGraphs.jl.

JuliaGraphs Central Website – 4 Wochen

• Übersicht: Die zentrale Website von JuliaGraphs bietet einen Überblick über die Pakete des Ökosystems. Es handelt sich jedoch in erster Linie um eine Beschreibung und kann weiter verbessert werden, um die erste Ressource für Personen zu werden, die mit der Erstellung von Grafiken in Julia beginnen. Ich werde eine intuitive Möglichkeit mit Visualisierung finden, um die Funktionen verschiedener JuliaGraphs-Pakete hervorzuheben.
• Ergebnisse: Ich werde Anwendungsfälle und Beispiele zur Hervorhebung der Funktionen von JuliaGraphs-Paketen vorstellen und eine Prüfung durchführen, um sicherzustellen, dass sie weiterhin relevant und unterstützt werden. Ich werde einen Abschnitt erstellen, in dem die verschiedenen Verwendungsmöglichkeiten der verschiedenen Pakete in verschiedenen Bereichen (Gesundheitswesen, Bildung usw.) hervorgehoben werden. Sofern die Zeit es zulässt, werde ich visuelle Erklärungen zu den in Google-Grafiken verwendeten Algorithmen recherchieren.
• Hinweise: Viele JuliaGraphs-Pakete werden in verschiedenen Bereichen häufig verwendet. Neben Plotter-Erweiterungen wie DiGraph for NetworkViz möchte ich auch einige andere Anwendungen in bestimmten Fächern vorstellen, z. B. MetaGraph for BioStructures in Biology, DijkstraState for TrafficAssighnment in Urban Planning, DiGraph for TreeView in Education usw.