You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- A few manually selected occurrences of LightGraphs are retained
- Some README verbiage is edited to explain and match the rename
- Also replaces the LightGraphs UUID with the Graphs UUID
If you want to generate the automatic rename from the previous commit
you can run the command
git ls-files | xargs perl -i -ple 's/LightGraphs/Graphs/g'
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -53,34 +53,34 @@ end
53
53
This gives users the option of reusing memory and improving performance.
54
54
55
55
### Minimizing use of internal struct fields
56
-
Since LightGraphs supports multiple implementations of the graph datastructure using the `AbstractGraph`[type](https://juliagraphs.github.io/LightGraphs.jl/latest/types.html#AbstractGraph-Type-1), you should refrain from using the internal fields of structs such as `fadjlist`. Instead, you should use the functions provided in the api. Code that is instrumental to defining a concrete graph type can use the internal structure of that type for example graph generators in `/src/StaticGraphs/generators/staticgraphs.jl` use the `fadjlist` field in order to construct graphs efficiently.
56
+
Since Graphs supports multiple implementations of the graph datastructure using the `AbstractGraph`[type](https://juliagraphs.github.io/Graphs.jl/latest/types.html#AbstractGraph-Type-1), you should refrain from using the internal fields of structs such as `fadjlist`. Instead, you should use the functions provided in the api. Code that is instrumental to defining a concrete graph type can use the internal structure of that type for example graph generators in `/src/StaticGraphs/generators/staticgraphs.jl` use the `fadjlist` field in order to construct graphs efficiently.
57
57
58
58
## Git usage
59
59
60
-
In order to make it easier for you to review Pull Requests (PRs), you can add this to your git config file, which should be located at `$HOME/.julia/dev/LightGraphs/.git/config`. Follow the instructions [here](https://gist.github.com/piscisaureus/3342247).
60
+
In order to make it easier for you to review Pull Requests (PRs), you can add this to your git config file, which should be located at `$HOME/.julia/dev/Graphs/.git/config`. Follow the instructions [here](https://gist.github.com/piscisaureus/3342247).
61
61
62
62
Locate the section for your github remote in the `.git/config` file. It looks like this:
Now add the line `fetch = +refs/pull/*/head:refs/remotes/origin/pr/*` to this section. Obviously, change the github url to match your project's URL. It ends up looking like this:
**Project Status:** As of 8 October 2021 LightGraphs is no longer under active development. It will remain available on Github at [sbromberger/LightGraphs.jl](https://github.com/sbromberger/LightGraphs.jl). The JuliaGraphs organization will continue to maintain packages that use LightGraphs and transition development over the long term.
8
+
**Project Status:** The Graphs project is a fork of the now-archived LightGraphs
9
+
package, which remains available on GitHub at
10
+
[sbromberger/LightGraphs.jl](https://github.com/sbromberger/LightGraphs.jl). If
11
+
you don't need any new features developed since the fork, you can continue to
12
+
use older versions of LightGraphs indefinitely. New versions will be released
13
+
here using the name Graphs instead of LightGraphs. There was an older package
14
+
also called Graphs, whose source history and versions are still available in
15
+
this repository, but the current code base is unrelated to the old Graphs code
16
+
and is derived purely from LightGraphs.
9
17
10
-
LightGraphs offers both (a) a set of simple, concrete graph implementations -- `Graph`
18
+
Graphs offers both (a) a set of simple, concrete graph implementations -- `Graph`
11
19
(for undirected graphs) and `DiGraph` (for directed graphs), and (b) an API for
12
20
the development of more sophisticated graph implementations under the `AbstractGraph`
13
21
type.
@@ -33,27 +41,30 @@ Additional functionality may be found in a number of companion packages, includi
33
41
Pajek NET, and more.
34
42
35
43
## Documentation
36
-
Full documentation is available at [GitHub Pages](https://juliagraphs.github.io/LightGraphs.jl/latest).
44
+
Full documentation is available at [GitHub Pages](https://juliagraphs.github.io/Graphs.jl/latest).
37
45
Documentation for methods is also available via the Julia REPL help system.
38
46
Additional tutorials can be found at [JuliaGraphsTutorials](https://github.com/JuliaGraphs/JuliaGraphsTutorials).
39
47
40
48
## Installation
41
49
Installation is straightforward: enter Pkg mode by hitting `]`, and then
42
50
```julia-repl
43
-
(v1.0) pkg> add LightGraphs
51
+
(v1.0) pkg> add Graphs
44
52
```
45
53
46
54
## Supported Versions
47
-
* 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).
48
-
* Julia 0.3: LightGraphs v0.3.7 is the last version guaranteed to work with Julia 0.3.
49
-
* Julia 0.4: LightGraphs versions in the 0.6 series are designed to work with Julia 0.4.
50
-
* Julia 0.5: LightGraphs versions in the 0.7 series are designed to work with Julia 0.5.
51
-
* Julia 0.6: LightGraphs versions in the 0.8 through 0.12 series are designed to work with Julia 0.6.
52
-
* Julia 0.7 / 1.0: LightGraphs versions in the 1.x series are designed to work with Julia 0.7 and Julia 1.0.
55
+
* Graphs 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).
56
+
* The project was previously developed under the name LightGraphs and older versions of LightGraphs (≤ v1.3.5) must still be used with that name.
57
+
* There was also an older package also called Graphs (git tags `v0.2.5` through `v0.10.3`), but the current code base here is a fork of LightGraphs v1.3.5.
58
+
* All older LightGraphs versions are tagged using the naming scheme `lg-vX.Y.Z` rather than plain `vX.Y.Z` which is used for old Graphs versions (≤ v0.10) and newer versions derived from LightGraphs but released with the Graphs name (≥ v1.4).
59
+
* Julia 0.3: LightGraphs v0.3.7 (`lg-v0.3.7`) is the last version guaranteed to work with Julia 0.3.
60
+
* Julia 0.4: LightGraphs versions in the 0.6 series (`lg-v0.6.*`) are designed to work with Julia 0.4.
61
+
* Julia 0.5: LightGraphs versions in the 0.7 series (`lg-v0.7.*`) are designed to work with Julia 0.5.
62
+
* Julia 0.6: LightGraphs versions in the 0.8 through 0.12 (`lg-v0.{8-12}.*`) series are designed to work with Julia 0.6.
63
+
* Julia 0.7 / 1.0: LightGraphs versions in the 1.x series (`lg-v1.*`) are designed to work with Julia 0.7 and Julia 1.0.
53
64
* Later versions: Some functionality might not work with prerelease / unstable / nightly versions of Julia. If you run into a problem, please file an issue.
54
65
55
66
# Contributing and Reporting Bugs
56
-
We welcome contributions and bug reports! Please see [CONTRIBUTING.md](https://github.com/JuliaGraphs/LightGraphs.jl/blob/master/CONTRIBUTING.md)
67
+
We welcome contributions and bug reports! Please see [CONTRIBUTING.md](https://github.com/JuliaGraphs/Graphs.jl/blob/master/CONTRIBUTING.md)
We encourage you to cite our work if you have used our libraries, tools or datasets. Starring the repository on GitHub is also appreciated.
2
2
3
-
The latest citation information may be found in the [CITATION.bib](https://raw.githubusercontent.com/JuliaGraphs/LightGraphs.jl/master/CITATION.bib) file
4
-
within the LightGraphs repository.
3
+
The latest citation information may be found in the [CITATION.bib](https://raw.githubusercontent.com/JuliaGraphs/Graphs.jl/master/CITATION.bib) file
4
+
within the Graphs repository.
5
5
6
6
For previous versions, [please reference the zenodo site](https://zenodo.org/record/889971).
0 commit comments