Skip to content

Commit 24ef961

Browse files
committed
Init
0 parents  commit 24ef961

87 files changed

Lines changed: 29748 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
jobs:
12+
deploy:
13+
name: Deploy to GitHub Pages
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- uses: actions/setup-node@v3
18+
with:
19+
node-version: 18
20+
cache: npm
21+
- name: Configure Git
22+
run: |
23+
git config user.name "Publisher"
24+
git config user.email "publisher@users.noreply.github.com"
25+
- name: Build website
26+
run: npm install
27+
- name: Build website
28+
run: npm run build
29+
- name: Switch to branch 'gh-pages'
30+
run: |
31+
git branch -f gh-pages HEAD
32+
git checkout gh-pages
33+
- run: |
34+
git add -f build/
35+
git commit -m "Publish"
36+
git push -f origin `git subtree split -P build`:refs/heads/gh-pages

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

docs/01_Intro.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Gephi Developper Documentation
6+

docs/02_Manuals/Code-Style.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
id: code-style
3+
title: Code Style
4+
tags:
5+
- Code Style
6+
- Development
7+
---
8+
The source code uses the [CheckStyle](https://checkstyle.sourceforge.io/) tool to keep the code style consistent.
9+
10+
In addition, we check for code style when building the project using the [Maven CheckStyle Plugin](http://maven.apache.org/plugins/maven-checkstyle-plugin/). A pull request without proper code style would fail to build.
11+
12+
### IntelliJ Setup
13+
14+
On IntelliJ follow these steps to configure CheckStyle:
15+
16+
1. Install the [CheckStyle plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea)
17+
2. Open `Preferences/Settings` and go to `Editor > Code Style`.
18+
3. Select `Project` as `Scheme` and click the settings icon next to it.
19+
4. Select `Import Scheme > CheckStyle Configuration` and locate the `checkstyle.xml` file at the root of Gephi's repository.
20+
21+
You're done. You can now use the built-in **Code > Reformat Code** tool. The resulting code style will match what is on the Gephi repository.

docs/02_Manuals/Datasets.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
id: datasets
3+
title: Datasets
4+
---
5+
6+
The Gephi sample datasets below are available in various formats (GEXF, GDF, GML, NET, GraphML, DL, DOT). Feel free to add new datasets, but be sure to cite the original authors.
7+
8+
**Supported graph formats are described [here](https://gephi.org/users/supported-graph-formats/).**
9+
10+
Gephi can open zipped files directly.
11+
12+
## Web and Internet
13+
14+
- [GEXF file](https://gephi.org/datasets/eurosis.gexf.zip). **EuroSiS web mapping study**: Mapping interactions between Science in Society actors on the Web of 12 European countries. Original report and data can be found [here](http://www.webatlas.fr/exhibition/eurosis/).
15+
- [GML file](https://gephi.org/datasets/internet_routers-22july06.gml.zip). **Internet**: a symmetrized snapshot of the structure of the Internet at the level of autonomous systems, reconstructed from BGP tables posted by the [University of Oregon Route Views Project](http://routeviews.org/). This snapshot was created by Mark Newman on July 22, 2006 and was not previously published.
16+
17+
## Social networks
18+
19+
- [GML file](https://gephi.org/datasets/lesmiserables.gml.zip). **Les Miserables**: coappearance weighted network of characters in the novel Les Miserables. D. E. Knuth, The Stanford GraphBase: A Platform for Combinatorial Computing, Addison-Wesley, Reading, MA (1993).
20+
- [GEXF file](https://gephi.org/datasets/ht2009_15min.gexf.gz). **Hypertext 2009 dynamic contact network**: contact network during the Hypertext 2009 conference. Source: [Sociopatterns.org](http://www.sociopatterns.org/datasets/hypertext-2009-dynamic-contact-network/).
21+
- [GEXF file](https://zenodo.org/record/4612153#.YFIuQi1Xaw4). **CLASS OF 1880/81**: friendship network of a German boys' school class from 1880/1881. It's based on the probably first ever primarily collected social network dataset, assembled by the primary school teacher Johannes Delitsch. The data was reanalyzed and compiled for the article: [Heidler, R., Gamper, M., Herz, A., Eßer, F. (2014): Relationship patterns in the 19th century: The friendship network in a German boys' school class from 1880 to 1881 revisited. Social Networks 13: 1--13.](http://www.sciencedirect.com/science/article/pii/S0378873313000865).
22+
- [GML file](https://gephi.org/datasets/karate.gml.zip). **Zachary's karate club**: social network of friendships between 34 members of a karate club at a US university in the 1970s. W. W. Zachary, An information flow model for conflict and fission in small groups, Journal of Anthropological Research 33, 452-473 (1977).
23+
- [GML file](https://gephi.org/datasets/netscience.gml.zip). **Coauthorships in network science**: coauthorship network of scientists working on network theory and experiment, as compiled by M. Newman in May 2006. A figure depicting the largest component of this network can be found here. M. E. J. Newman, Phys. Rev. E 74, 036104 (2006).
24+
- [GEXF file](https://gephi.org/datasets/cpan-authors.gexf.zip). **CPAN authors**: CPAN Explorer is a visualization project aiming at analyzing the relationships between the developers and the packages of the Perl language, known as the CPAN community. This snapshot was created by Linkfluence in July 2009. This file contains the network of developers, linked when they use the same Perl module. Original data can be found [here](http://cpan-explorer.org/).
25+
- [GEXF file](https://gephi.org/datasets/cpan-distributions.gexf.zip). **CPAN distributions**: CPAN Explorer is a visualization project aiming at analyzing the relationships between the developers and the packages of the Perl language, known as the CPAN community. This snapshot was created by Linkfluence in July 2009. This file contains the network of Perl modules dependencies. Orginal data can be found [here](http://cpan-explorer.org/).
26+
- [NET file](https://gephi.org/datasets/jazz.net.zip). **Jazz musicians network**: List of edges of the network of Jazz musicians. P.Gleiser and L. Danon , Adv. Complex Syst.6, 565 (2003).
27+
- [TGZ file](http://franck.lumberjaph.net/graphs.tgz). **Github open source developers**: See <https://github.com/franckcuny/blog/blob/master/posts/2010-03-25-github-explorer.md/>
28+
- [DL file](https://gephi.org/datasets/OClinks_w.dl.zip). **Online Social Network** 1899 nodes - Opsahl, T., Panzarasa, P., 2009. Clustering in weighted networks. Social Networks 31 (2), 155-163
29+
- [GEPHI file](https://gephi.org/datasets/hero-social-network.gephi). **The Marvel Social Network** Networks of super heroes, constructed by Cesc Rosselló, Ricardo Alberich, and Joe Miro from the University of the Balearic Islands. Collected by [Infochimps](http://www.infochimps.com/datasets/marvel-universe-social-graph) and transformed & enhanced by Kai Chang.
30+
- [GDF file](https://gephi.org/datasets/comic-hero-network.gdf.zip). **Comic and Hero Network** Same data as above, but this includes the comics the heroes appear in.
31+
- [DOT file](http://rankinfo.pkqs.net/twittercrawl.dot.gz). **Twitter mentions and retweets** of some part of the Twitter network. The file is updated from time to time.
32+
- [GEXF file](http://www.sociopatterns.org/datasets/primary-school-cumulative-networks/). **Contact networks** in a primary school, SocioPatterns team, 2011.
33+
- [GEXF file](https://github.com/mbingenheimer/ChineseBuddhism_SNA). **Historical Social Network of Chinese Buddhism 漢傳佛教歷史社會網絡** 17,000+ persons, 25,000+ connections.
34+
35+
## Biological networks
36+
37+
- [GEXF](http://gephi.org/datasets/diseasome.gexf.zip). **Diseasome**: A network of disorders and disease genes linked by known disorder–gene associations, indicating the common genetic origin of many diseases. Genes associated with similar disorders show both higher likelihood of physical interactions between their products and higher expression profiling similarity for their transcripts, supporting the existence of distinct disease-specific functional modules. The original dataset can be found here: The Human Disease Network, Goh K-I, Cusick ME, Valle D, Childs B, Vidal M, Barabási A-L (2007), Proc Natl Acad Sci USA 104:8685-8690
38+
- [GEXF](http://gephi.org/datasets/celegans.gexf.zip). **C. Elegans neural network**: A directed, weighted network representing the neural network of C. Elegans. Data compiled by D. Watts and S. Strogatz and made available on the web here. Please cite D. J. Watts and S. H. Strogatz, Nature 393, 440-442 (1998). Original experimental data taken from J. G. White, E. Southgate, J. N. Thompson, and S. Brenner, Phil. Trans. R. Soc. London 314, 1-340 (1986).
39+
- [GEXF](https://gephi.org/datasets/yeast.gexf.zip). **Yeast**: Protein-Protein interaction network in yeast. Original data can be found [here](http://vlado.fmf.uni-lj.si/pub/networks/data/bio/Yeast/Yeast.htm).
40+
41+
## Infrastructure networks
42+
43+
- [GML](https://gephi.org/datasets/power.gml.zip). **Power grid**: An undirected, unweighted network representing the topology of the Western States Power Grid of the United States. Data compiled by D. Watts and S. Strogatz and made available on the web here. Please cite D. J. Watts and S. H. Strogatz, Nature 393, 440-442 (1998).
44+
- [GRAPHML](https://gephi.org/datasets/airlines.graphml.zip). **Airlines**: unknown source.
45+
- [NET](https://gephi.org/datasets/us-air97.net.zip). **US Air97**: North American Transportation Atlas Data (NORTAD). Original data can be found [here](http://vlado.fmf.uni-lj.si/pub/networks/pajek/data/gphs.htm).
46+
47+
## Other networks
48+
49+
- [GEXF](https://gephi.org/datasets/codeminer.gexf.zip). **Java code**: Source code structure of a Java program, by S.Heymann & J.Palmier, 2008.
50+
- [GEXF](https://gephi.org/datasets/photoviz-dynamic.gexf.zip). **Dynamic Java code**: Dynamic source code structure of a Java program by evolution of commits on the SVN, by S.Heymann & J.Bilcke, 2008.
51+
- [GML](https://gephi.org/datasets/word_adjacencies.gml.zip). **Word adjacencies**: adjacency network of common adjectives and nouns in the novel David Copperfield by Charles Dickens. Please cite M. E. J. Newman, Phys. Rev. E 74, 036104 (2006).
52+
- [NET](https://gephi.org/datasets/wordnet3.net.zip). **Wordnet English dictionary**: unknown source.
53+
- [DOT](https://gephi.org/datasets/hex.dot.zip). **Abstract mesh**: 331 nodes.
54+
55+
## Sources
56+
57+
Some of the above datasets are from:
58+
- [Mark Newman](http://www-personal.umich.edu/~mejn/netdata/)
59+
- [Alexandre Arenas](http://deim.urv.cat/~aarenas/data/welcome.htm)
60+
- [Albert-László Barabási](http://www.nd.edu/~networks/resources.htm)
61+
- [Vladimir Batagelj and Andrej Mrvar](http://vlado.fmf.uni-lj.si/pub/networks/pajek/data/gphs.htm)
62+
- [Tore Opsahl](http://toreopsahl.com/datasets/)
63+
64+
## Other network data repositories
65+
66+
- [Duncan Watts](http://cdg.columbia.edu/cdg/datasets)
67+
- [Kevin Chai](http://kevinchai.net/datasets/)
68+
- [Indiana University](http://iv.slis.indiana.edu/db/index.html)
69+
- [Trust networks dataset at trustlet.org](http://www.trustlet.org/wiki/Trust_network_datasets#Released_datasets)
70+
- [Data sets at CFinder.org](http://cfinder.org/data)
71+
- [SNAP data](http://snap.stanford.edu/data)
72+
- [UC Irvine Network Data Repository](http://networkdata.ics.uci.edu/)
73+
- [The Internet Topology Zoo](http://topology-zoo.org/)
74+
- [Yahoo! Graph Datasets](http://webscope.sandbox.yahoo.com/catalog.php?datatype=g)
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
id: developer-handbook
3+
title: Developer Handbook
4+
---
5+
6+
This page explains how to contribute to Gephi's development.
7+
8+
## How to download the development version of Gephi
9+
10+
### Prerequisites
11+
12+
- Note: Gephi uses multi-platforms tools, so all the following steps should be the same (well, mostly) whatever the OS you are running
13+
- First, you will need [git](http://git-scm.com/download) to download the files.
14+
- You also need [Netbeans 8.0+](http://netbeans.org/)
15+
16+
### Getting the source code
17+
18+
- Read the full instructions: [[Checkout Code]]
19+
20+
Now you should have a Gephi fork and a master branch.
21+
22+
Set up your account credentials to Git:
23+
```sh
24+
git config --global user.name "Firstname Lastname"
25+
git config --global user.email "your_email@youremail.com"
26+
```
27+
28+
### Compiling and Running Gephi
29+
30+
Read full instructions: [[Configuring NetBeans]]
31+
32+
## How to create and publish your own feature
33+
34+
### Configure your forked repository
35+
36+
- You’ve successfully forked the Gephi repository and got the code in a gephi folder by doing
37+
38+
``git clone git@github.com:username/gephi.git``
39+
40+
When a repo is cloned, it has a default remote called origin that points to your fork on GitHub, not the original repo it was forked from. To keep track of the original repo, you need to add another remote named upstream:
41+
42+
```sh
43+
cd gephi
44+
git remote add upstream git://github.com/gephi/gephi.git
45+
git fetch upstream master
46+
```
47+
48+
This keeps your fork up to date. Each time you run ``git fetch upstream master`` it downloads the latest changes from the main repository (not your fork). Note that this does NOT change any of your files. You'll need a merge to actually apply the latest changes to your fork.
49+
50+
### Push commits
51+
52+
When you work on the code, commit often!
53+
The commit process is straightforward. First add all the files you want to include in your commit:
54+
55+
``git add .``
56+
57+
Then commit these files
58+
59+
``git commit -m "This is my first commit hourray"``
60+
61+
Run git status often to see what your repository is up to.
62+
Your commits are local. To send them to GitHub run:
63+
64+
``git push origin master``
65+
66+
### Merge from the main repository
67+
68+
When we update the main gephi repository, your fork doesn't get updated automatically. To merge the latest commits to your fork, run a merge from upstream:
69+
70+
```sh
71+
git fetch upstream master
72+
git merge upstream/master
73+
```
74+
75+
To fetch and merge in one line, simply run
76+
77+
``git pull upstream master``
78+
79+
When you merge, you may run into conflicts. This is normal if you worked on the same files.
80+
Note that ``git fetch upstream`` or ``git pull upstream`` will download the data from all branches, which you probably don't need. That's why we add 'master' to specify which branch to fetch to.
81+
82+
### Send pull requests
83+
84+
That's the standard and easiest way to contribute to the project. It's fully integrated into GitHub and well explained [here](http://help.github.com/send-pull-requests/).
85+
86+
## How to contribute to the main project
87+
88+
When you are a member of the gephi team, you have the write rights on the main repository. Instead of submitting pull requests you simply commit to the repository, including the master branch.
89+
Change your upstream push url to authenticated version:
90+
91+
``git remote set-url upstream git@github.com:gephi/gephi.git``
92+
93+
Push to the master branch. Make sure you pulled to the latest revision before (git pull upstream master).
94+
95+
``git push upstream master``

0 commit comments

Comments
 (0)