Repository files navigation

Project Status: As of 8 October 2021 LightGraphs is no longer under active development. It will remain available on Github atsbromberger/LightGraphs.jl. The JuliaGraphs organization will continue to maintain packages that use LightGraphs and transition development over the long term.

LightGraphs offers both (a) a set of simple, concrete graph implementations --Graph(for undirected graphs) andDiGraph (for directed graphs), and (b) an API forthe development of more sophisticated graph implementations under theAbstractGraphtype.

The project goal is to mirror the functionality of robust network and graphanalysis libraries such asNetworkX while beingsimpler to use and more efficient than existing Julian graph libraries such asGraphs.jl. It is an explicit designdecision that any data not required for graph manipulation (attributes andother information, for example) is expected to be stored outside of the graphstructure itself. Such data lends itself to storage in more traditional andbetter-optimized mechanisms.

Additional functionality may be found in a number of companion packages, including:

• LightGraphsExtras.jl:extra functions for graph analysis.
• MetaGraphs.jl: graphs withassociated meta-data.
• SimpleWeightedGraphs.jl:weighted graphs.
• GraphIO.jl: tools for importingand exporting graph objects using common file types like edgelists, GraphML,Pajek NET, and more.

Full documentation is available atGitHub Pages.Documentation for methods is also available via the Julia REPL help system.Additional tutorials can be found atJuliaGraphsTutorials.

Installation is straightforward: enter Pkg mode by hitting], and then

(v1.0) pkg> add LightGraphs

• LightGraphs master is generally designed to work with the latest stable version of Julia (except during Julia version increments as we transition to the new version).
• Julia 0.3: LightGraphs v0.3.7 is the last version guaranteed to work with Julia 0.3.
• Julia 0.4: LightGraphs versions in the 0.6 series are designed to work with Julia 0.4.
• Julia 0.5: LightGraphs versions in the 0.7 series are designed to work with Julia 0.5.
• Julia 0.6: LightGraphs versions in the 0.8 through 0.12 series are designed to work with Julia 0.6.
• Julia 0.7 / 1.0: LightGraphs versions in the 1.x series are designed to work with Julia 0.7 and Julia 1.0.
• Later versions: Some functionality might not work with prerelease / unstable / nightly versions of Julia. If you run into a problem, please file an issue.

We welcome contributions and bug reports! Please seeCONTRIBUTING.mdfor guidance on development and bug reporting.

We encourage you to cite our work if you have used our libraries, tools or datasets.Starring the repository on GitHub is also appreciated.See the Zenodo badge above or refer toCITATION.bib.