پروژه زبان جولیا

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه پروژه

سازمان منبع باز:

زبان جولیا

نویسنده فنی:

شو لیو

نام پروژه:

LightGraphs Docs 2.0 و آموزش های کاربرپسند JuliaGraphs

طول پروژه:

دویدن طولانی مدت (5 ماه)

شرح پروژه

در این پروژه طولانی مدت، وب سایت و مستندات ماژول ها را در JuliaGraphs بهتر خواهم کرد. به طور خاص، کار من شامل اما نه محدود به مطالب زیر است.

LightGraphs Docs 2.0 - 10 Weeks

• نمای کلی: LightGraphs.jl یک بسته گراف سبک وزن بهینه شده برای جولیا است که به عنوان هسته اکوسیستم JuliaGraphs عمل می کند. نسخه 2.0 آینده LightGraphs نشان دهنده یک تغییر اساسی در LightGraphs API است. من مطمئن خواهم شد که مستندات جدیدترین و بهترین ویژگی های LightGraphs را نشان می دهد.
• موارد قابل تحویل: من یک ممیزی از اسناد API موجود انجام می دهم تا ببینم چه اسنادی می توانند ثابت بمانند و تغییرات ایجاد شده در نسخه 2.0 را تجزیه و تحلیل می کنم تا مطمئن شوم که به درستی با مثال هایی مستند شده اند. در طول این فرآیند، من پست هایی خواهم نوشت که تغییرات عمده در نسخه 2.0 را برجسته می کند. برای کمک به تازه واردان برای درک بهتر LightGraphs، من راهنماهای مبتدی را برای کسانی که اولین قدم خود را به دنیای استفاده از نمودارها در جولیا بر می دارند ایجاد خواهم کرد.
• نکات: در این پروژه، Documenter.jl به عنوان تولید کننده سند برای ساخت اسناد LightGraphs استفاده خواهد شد. علاوه بر ارجاعات API برای ماژول هایی مانند Coloring.jl، من به آنها برای زیر ماژول هایی مانند greedy_color.jl نیز نیاز دارم. من نحوه اضافه کردن آنها را برای تجدید اسناد LightGraphs بررسی خواهم کرد. علاوه بر این، نظریه گراف یک زمینه فنی بسیار زیبا از ریاضیات است و برای کسانی که پیشینه ریاضی ندارند مبهم است. من حدود 2 سال است که درگیر تحقیقات آکادمیک هستم و پست های وبلاگ زیادی در وب سایت شخصی خود نوشته ام، بنابراین مطمئن هستم که می توانم اصل الگوریتم های مختلف را توضیح دهم و نکاتی را ارائه دهم که در موقعیت های مختلف هنگام ایجاد راهنماهای مبتدی از آنها استفاده کنم.

آموزش JuliaGraphs - 10 هفته

• نمای کلی: بسیاری از اسناد بسته های JuliaGraphs توسعه دهنده هستند. من چند مثال ساده اضافه می کنم و استفاده از هر ویژگی را نشان می دهم و آن را برای کاربران قابل دسترس تر می کنم.
• موارد قابل تحویل: من یک ممیزی از آموزش های LightGraphs موجود انجام خواهم داد تا ببینم چه موادی باید اضافه شوند و استفاده و انگیزه هر ویژگی را نشان می دهم. سپس من روش JuliaGraphsTutorials را برای گسترش آموزش های JuliaGraphs از جمله راهنمای مبتدی در اکوسیستم LightGraphs دنبال خواهم کرد.
• نکات: محتوای JuliaGraphsTutorials در حال حاضر به اندازه کافی کامل نیست، موارد تحویلی ذکر شده در بالا بیشتر برای بسته LightGraphs هستند. اگر زمان اجازه دهد، من همچنین آموزش‌هایی را برای ماژول‌های دیگر در JuliaGraphs مانند GraphPlot.jl ، MetaGraphs.jl و SimpleWeightedGraphs.jl اضافه می‌کنم.

وب سایت مرکزی JuliaGraphs - 4 Weeks

• نمای کلی: وب سایت مرکزی JuliaGraphs یک نمای کلی از بسته های اکوسیستم ارائه می دهد. با این حال، هنوز هم عمدتاً یک توصیف است و می‌توان آن را بیشتر بهبود بخشید تا به اولین منبع برای افرادی تبدیل شود که با نمودارها در جولیا شروع می‌کنند. من می خواهم راهی بصری با تجسم پیدا کنم تا ویژگی های بسته های مختلف JuliaGraphs را برجسته کنم.
• موارد تحویلی: من موارد و مثال‌هایی را برای برجسته کردن قابلیت‌های بسته‌های JuliaGraphs و انجام ممیزی ارائه می‌دهم تا مطمئن شویم که هنوز مرتبط و پشتیبانی می‌شوند. من بخشی ایجاد خواهم کرد که کاربردهای مختلف بسته های مختلف را در حوزه های مختلف (بهداشت، آموزش، و غیره) برجسته می کند.
• نکات: بسیاری از بسته های JuliaGraphs به طور گسترده در حوزه های مختلف مورد استفاده قرار گرفته اند. علاوه بر ترسیم برنامه‌های افزودنی مانند DiGraph برای NetworkViz ، برخی از برنامه‌های کاربردی دیگر در موضوعات خاص که می‌خواهم شامل MetaGraph برای BioStructures در زیست‌شناسی، DijkstraState برای TrafficAssighnment در برنامه‌ریزی شهری ، DiGraph برای TreeView در آموزش و غیره باشد.