Skip to content

Commit a819c62

Browse files
authored
Merge pull request #2 from gephi/u/totetmatt/local_image
Local image + optipng
2 parents 49ef691 + 4538c90 commit a819c62

86 files changed

Lines changed: 73 additions & 75 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.

docs/01_User_Manual/02-GUI.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,111 +16,111 @@ Modes are accessible under the main menu:
1616
- **Data Laboratory**: data visualization in tables.
1717
- **Preview**: visual tuning before vectorial export.
1818

19-
![image](https://cloud.githubusercontent.com/assets/177962/5592891/ff1400d0-91e9-11e4-97bf-f9bcb28c95e1.png)
19+
![image](/docs/01_User_Manual/02-GUI/00_image.png)
2020

21-
![image](https://cloud.githubusercontent.com/assets/177962/5592889/d47429fe-91e9-11e4-801b-af3430b381b9.png)
21+
![image](/docs/01_User_Manual/02-GUI/01_image.png)
2222

23-
![image](https://cloud.githubusercontent.com/assets/177962/5592892/0b62b3ea-91ea-11e4-8fcc-158facd255eb.png)
23+
![image](/docs/01_User_Manual/02-GUI/02_image.png)
2424

2525
### Workspaces
2626

2727
A workspace is a whole environment for exploring one graph. If you want to analyze more graphs simultaneously, you need to create new workspaces. Create, delete and clean workspace data from the Edit menu.
2828
Note that each new graph import creates a new workspace if you select the "Add full graph" option in the import window. Hence you are still able to work on the first graph later.
2929

30-
![image](https://cloud.githubusercontent.com/assets/177962/5592898/4c1f69aa-91ea-11e4-82cb-d6e5f73f40d7.png)
30+
![image](/docs/01_User_Manual/02-GUI/03_image.png)
3131

3232
## Overview
3333

3434
### Graph and Tools
3535

36-
![image](https://cloud.githubusercontent.com/assets/177962/5592901/5db09874-91ea-11e4-8601-cb3f7b5d7c7e.png)
36+
![image](/docs/01_User_Manual/02-GUI/04_image.png)
3737
**Graph window** - Graph rendered on the center and tools on the sides.
3838

39-
![image](https://cloud.githubusercontent.com/assets/177962/5592902/6c2804f0-91ea-11e4-9ed5-0b5643303610.png)
39+
![image](/docs/01_User_Manual/02-GUI/05_image.png)
4040
**Select** Highlight nodes under the cursor.
4141

42-
![image](https://cloud.githubusercontent.com/assets/177962/5592904/7ceb37ee-91ea-11e4-8d10-e3049f77f4f0.png)
42+
![image](/docs/01_User_Manual/02-GUI/06_image.png)
4343
**Edge selection color** Incoming links are colored differently than outgoing links.
4444

45-
![image](https://cloud.githubusercontent.com/assets/177962/5592907/88b4e462-91ea-11e4-9ce7-144b5c211dcf.png)
45+
![image](/docs/01_User_Manual/02-GUI/07_image.png)
4646
**Heatmap** Set color intensity on a node neighborhood, by the distance.
4747

48-
![image](https://cloud.githubusercontent.com/assets/177962/5592910/93e37574-91ea-11e4-9640-e6f70fa02ea6.png)
48+
![image](/docs/01_User_Manual/02-GUI/08_image.png)
4949
**Multiple select** Nodes are selected under the rectangle.
5050

51-
![image](https://cloud.githubusercontent.com/assets/177962/5592912/9fe36f46-91ea-11e4-9f5c-bc4258d8fcd0.png)
51+
![image](/docs/01_User_Manual/02-GUI/09_image.png)
5252
**Shorthest path** Display the shortest path if exist between two clicked nodes.
5353

5454
### Layout
5555

5656
Select an algorithm and set parameters on the fly. Save them into presets.
5757

58-
![image](https://cloud.githubusercontent.com/assets/177962/5592915/c1db479a-91ea-11e4-8a75-b0a98ec98fb7.png)
58+
![image](/docs/01_User_Manual/02-GUI/10_image.png)
5959

6060
### Ranking
6161

6262
Set numerical attributes to distribute node/edge colors, sizes, label colors and label sizes. Right-click on the window to display the ranked list of nodes or edges.
6363

64-
![image](https://cloud.githubusercontent.com/assets/177962/5592917/ce762b32-91ea-11e4-83aa-b7bdb67c7739.png)
64+
![image](/docs/01_User_Manual/02-GUI/11_image.png)
6565

6666
### Partition
6767

6868
Node or edge grouping on attribute or computed metric. A color is assigned to each group, and can be changed by right-clicking on the window.
6969

70-
![image](https://cloud.githubusercontent.com/assets/177962/5592918/dd088172-91ea-11e4-9443-d5058c1f71bf.png)
70+
![image](/docs/01_User_Manual/02-GUI/12_image.png)
7171
Group List
7272

73-
![image](https://cloud.githubusercontent.com/assets/177962/5592919/e2bbd560-91ea-11e4-9cf1-cd8a9101cd16.png)
73+
![image](/docs/01_User_Manual/02-GUI/13_image.png)
7474
Pie chart
7575

7676
### Statistics/metrics
7777

7878
Run metrics and save reports in HTML. Node and edge computed results are available as attributes.
7979

80-
![image](https://cloud.githubusercontent.com/assets/177962/5592923/f6a3699e-91ea-11e4-8276-cd7237738a92.png)
80+
![image](/docs/01_User_Manual/02-GUI/14_image.png)
8181

8282
### Filters
8383

8484
A library of filters is available to combine. Drag the filter (e.g., Degree Range) to build the query, and then set the parameters visually. Finally apply the query output to select elements or to filter them. When filtering is activated, changes appear in real time.
8585

86-
![image](https://cloud.githubusercontent.com/assets/177962/5592924/02dc483e-91eb-11e4-840f-50b8d081b90d.png)
86+
![image](/docs/01_User_Manual/02-GUI/15_image.png)
8787

8888
### Timeline
8989

9090
Move left and right cursors to filter the graph on time intervals.
9191

92-
![image](https://cloud.githubusercontent.com/assets/177962/5592925/0f878ada-91eb-11e4-871f-d1d63d585861.png)
92+
![image](/docs/01_User_Manual/02-GUI/16_image.png)
9393

9494
The timeline opens automatically when you open a dynamic network. Enable the timeline to set the time interval. Drag the bounds of the interval using your mouse.
9595

9696
### Context
9797

9898
Display the number of nodes and edges, the type of the graph and the percentage of visible nodes.
9999

100-
![image](https://cloud.githubusercontent.com/assets/177962/5592927/1d806a76-91eb-11e4-9e15-6f62d129c1d8.png)
100+
![image](/docs/01_User_Manual/02-GUI/17_image.png)
101101

102102
### Edit
103103

104104
View and edit the attributes of a selected node.
105105

106-
![image](https://cloud.githubusercontent.com/assets/177962/5592929/292a6f5c-91eb-11e4-9c89-dd63b31d0fe4.png)
106+
![image](/docs/01_User_Manual/02-GUI/18_image.png)
107107

108108
## Data Laboratory
109109

110110
Show node and edge attributes in a table, which also allows for dynamic regexp filtering.
111111

112-
![image](https://cloud.githubusercontent.com/assets/177962/5592930/3eac363a-91eb-11e4-8e89-5d1ad36764b7.png)
112+
![image](/docs/01_User_Manual/02-GUI/19_image.png)
113113

114114
## Preview
115115

116116
### Settings
117117

118118
Customizable visuals for vectorial export, which may be saved as presets.
119119

120-
![image](https://cloud.githubusercontent.com/assets/177962/5592932/514e57e6-91eb-11e4-8e94-562145c49fcd.png)
120+
![image](/docs/01_User_Manual/02-GUI/20_image.png)
121121

122122
### Visualization
123123

124124
Fine tuning on nodes, edges and labels rendering.
125125

126-
![image](https://cloud.githubusercontent.com/assets/177962/5592936/5de54e24-91eb-11e4-8302-0bf891c4cfe8.png)
126+
![image](/docs/01_User_Manual/02-GUI/21_image.png)

docs/01_User_Manual/Import-CSV-Data.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Next we'll learn how to use the import wizard to customize the data to our needs
2121

2222
Start by clicking 'Import CSV' button in Data Laboratory as shown in the picture
2323

24-
![launch-import-csv-wizard](https://cloud.githubusercontent.com/assets/197285/5621089/42079e06-9532-11e4-8060-c8331475fad6.png)
24+
![launch-import-csv-wizard](/docs/01_User_Manual/Import-CSV-Data/00_launch-import-csv-wizard.png)
2525

2626
Then the import wizard will open and you are presented with some generic, table independent options.
2727

28-
![import-csv-step1](https://cloud.githubusercontent.com/assets/197285/5621090/4c450e1c-9532-11e4-98f1-f14a5f17b55f.png)
28+
![import-csv-step1](/docs/01_User_Manual/Import-CSV-Data/01_import-csv-step1.png)
2929

3030
In this step you will indicate the format of the CSV file and can preview the resulting table.
3131

@@ -44,7 +44,7 @@ This final step offers some common options and behaviour descriptions for both n
4444

4545
When importing to nodes table you can also indicate if you want to update a node's data instead of creating a new node when a node with that id already exists.
4646

47-
![import-csv-step2-nodes](https://cloud.githubusercontent.com/assets/197285/5621094/520d375c-9532-11e4-9779-a77ee3474fa3.png)
47+
![import-csv-step2-nodes](/docs/01_User_Manual/Import-CSV-Data/02_import-csv-step2-nodes.png)
4848

4949
### Importing to edges table
5050

@@ -53,4 +53,4 @@ In case of importing to edges table, the behaviour is a bit different:
5353
- 'Source' and 'Target' node Ids are mandatory for all rows
5454
- Edge type is optional and its default is 'Directed'
5555

56-
![import-csv-step2-edges](https://cloud.githubusercontent.com/assets/197285/5621096/5661d20e-9532-11e4-8c8d-e3dcfb779c70.png)
56+
![import-csv-step2-edges](/docs/01_User_Manual/Import-CSV-Data/03_import-csv-step2-edges.png)

docs/01_User_Manual/Import-Dynamic-Data.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Import Dynamic Data
55

66
Longitudinal (also called dynamic) networks are simply networks that evolve chronologically. If you imagine the network of your friends, the number of nodes, connections and attribute values grow and change as time passes. We call these dynamic attributes, because they have values associated with a particular moment.
77

8-
![intro-longitudinal](https://cloud.githubusercontent.com/assets/197285/5621316/9be7595a-9534-11e4-920e-a7326d588bcf.png)
8+
![intro-longitudinal](/docs/01_User_Manual/Import-Dynamic-Data/00_intro-longitudinal.png)
99

1010
*Longitudinal Networks*
1111

@@ -15,7 +15,7 @@ There are two ways to model a longitudinal network, either a collection of netwo
1515

1616
Imagine a network of three nodes for the years 2007, 2008 and 2009. The years these nodes are present can be represented either as distinct points in time or as time intervals (as pictured on the left and right sides of the arrow below, respectively).
1717

18-
![importdynamics-intervals](https://cloud.githubusercontent.com/assets/197285/5621313/9bd7b054-9534-11e4-96e5-709116563f63.png)
18+
![importdynamics-intervals](/docs/01_User_Manual/Import-Dynamic-Data/01_importdynamics-intervals.png)
1919

2020
The second node, 'n2', is present during all three years and is represented by brackets enclosing the first and last years [2007, 2009]. Gephi automatically includes any dates, such as 2008, within this range. The first node, 'n1', however, is closed with a parenthesis rather than a bracket. This means the node was present in 2008 but **NOT** in 2009.
2121

@@ -130,15 +130,15 @@ Imagine a social network where each node represents a friend of yours and one of
130130

131131
- **Step 1:** Click on **Merge Columns** manipulator in the Data Laboratory.
132132

133-
![transformlongitudinal-datalab1](https://cloud.githubusercontent.com/assets/197285/5621314/9be122d8-9534-11e4-9205-df450e73bc75.png)
133+
![transformlongitudinal-datalab1](/docs/01_User_Manual/Import-Dynamic-Data/02_transformlongitudinal-datalab1.png)
134134

135135
- **Step 2:** From the available columns on the left, add the column or columns (if you have both a start and end period) you want to use to create the time interval. Then select **Create time interval** from the available merge strategies.
136136

137-
![transformlongitudinal-datalab2](https://cloud.githubusercontent.com/assets/197285/5621317/9be849d2-9534-11e4-9b5d-e4988f3cf011.png)
137+
![transformlongitudinal-datalab2](/docs/01_User_Manual/Import-Dynamic-Data/03_transformlongitudinal-datalab2.png)
138138

139139
- **Step 3:** Select which column is the start and which is the end (or leave this blank if no end exists). If the column is numerical (integer, float, double), select **Parse numbers**. If the data are date strings, they can also be parsed and transformed into a time interval. Our 'First Met' column is just the day in the year, just a number.
140140

141-
![transformlongitudinal-datalab3](https://cloud.githubusercontent.com/assets/197285/5621319/9bf2350a-9534-11e4-9e2d-f970fb074cd9.png)
141+
![transformlongitudinal-datalab3](/docs/01_User_Manual/Import-Dynamic-Data/04_transformlongitudinal-datalab3.png)
142142

143143

144144
## Use Time Frame Import with several static files
@@ -248,14 +248,14 @@ Do the following steps on a clear project to import your dataset:
248248

249249
- **Step 1:** Import the first file and select **Time Frame** in the import report, click on OK. That will display a settings dialog.
250250

251-
![importtimeframe1](https://cloud.githubusercontent.com/assets/197285/5621315/9be5649c-9534-11e4-86ab-88917b936b8a.png)
251+
![importtimeframe1](/docs/01_User_Manual/Import-Dynamic-Data/05_importtimeframe1.png)
252252

253253
- **Step 2:** Select either a Date or a real number as a time format. Real numbers is the default choice, here we put the year 2007. Click on OK, the file is imported.
254254

255-
![importtimeframe2](https://cloud.githubusercontent.com/assets/197285/5621318/9bea3134-9534-11e4-81cd-d96d9c6e92c3.png)
255+
![importtimeframe2](/docs/01_User_Manual/Import-Dynamic-Data/06_importtimeframe2.png)
256256

257257
- **Step 3:** You can now do the same for all other files, in a chronological order. For the second file select 2008, then 2009 etc.
258258

259-
![importtimeframe3](https://cloud.githubusercontent.com/assets/197285/5621320/9bfd40d0-9534-11e4-9502-1440679e4096.png)
259+
![importtimeframe3](/docs/01_User_Manual/Import-Dynamic-Data/07_importtimeframe3.png)
260260

261261
The result is a longitudinal network in Gephi where nodes and edges have time intervals according how they were present in the different files. Similarly all attributes are dynamic attributes. The 'Price' attribute in the dataset in a **DYNAMIC_INTEGER** column and each value is associated with its interval. Moreover the edge's weight itself is dynamic.

docs/02_Developer_Documentation/How-to-build-Gephi.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Gephi software architecture is modular and therefore each feature is split into
2020

2121
* [Gephi APIs documentation](http://gephi.org/docs/api)
2222

23-
![image](https://cloud.githubusercontent.com/assets/177962/5606309/e7360250-9429-11e4-9085-d948267a3f7d.png)
23+
![image](/docs/02_Developer_Documentation/How-to-build-Gephi/00_image.png)
2424

2525
## Build Gephi
2626

@@ -70,19 +70,19 @@ Once built, Gephi can be run from the `modules/application` folder using a speci
7070

7171
Open Netbeans and go to **File > Open Project** to look for the Gephi folder. Then, **Open Project**. Ensure the checkbox "Open Required Projects" is not selected.
7272

73-
![Opening Gephi](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/open.png)
73+
![Opening Gephi](/docs/02_Developer_Documentation/How-to-build-Gephi/01_Opening Gephi.png)
7474

7575
Right-click on the project and select **Clean and Build**.
7676

77-
![Build](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/clean_and_build.png)
77+
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/02_Build.png)
7878

7979
Next, in the **Projects** tab of the file navigator, select **Gephi > Modules > gephi-app** and open the application module.
8080

81-
![Open gephi-app](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/open_app.png)
81+
![Open gephi-app](/docs/02_Developer_Documentation/How-to-build-Gephi/03_Open gephi-app.png)
8282

8383
Finally, select **Run** from this module.
8484

85-
![Run](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/run.png)
85+
![Run](/docs/02_Developer_Documentation/How-to-build-Gephi/04_Run.png)
8686

8787
### Troubleshooting
8888

@@ -96,37 +96,37 @@ As Gephi is a Maven project it is well supported by IntelliJ but requires some t
9696

9797
Open IntelliJ and open the Gephi folder. You'll be asked whether you want to Trust this Maven repository. Select **Trust Project**.
9898

99-
![Trust Maven](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-trust-maven.png)
99+
![Trust Maven](/docs/02_Developer_Documentation/How-to-build-Gephi/05_Trust Maven.png)
100100

101101
IntelliJ then takes some time to scan the project and resolve dependencies. Once completed, you should see Gephi properly listed as a project in the Project pane.
102102

103-
![Project loaded](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-project.png)
103+
![Project loaded](/docs/02_Developer_Documentation/How-to-build-Gephi/06_Project loaded.png)
104104

105105
Then, navigate to IntelliJ's preferences panel **Build, Execution, Deployment > Build Tools > Maven > Runner** and select the option **Delegate IDE build/run actions to Maven**. This is a critical step.
106106

107-
![Maven delegate config](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-maven-delegate.png)
107+
![Maven delegate config](/docs/02_Developer_Documentation/How-to-build-Gephi/07_Maven delegate config.png)
108108

109109
Next in the top-level menu select **Build > Build Project**.
110110

111111
If it fails with and error like `javac flag not found --release`, you would need to fo back to **Build, Execution, Deployment > Build Tools > Maven > Runner** and add an **Environment Variables** with `JAVA_HOME=<path of the selected JDK>`
112112

113-
![Build](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-build.png)
113+
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/08_Build.png)
114114

115115
Once completed, create a run configuration by following **Run > Edit Configurations...** in the top-level menu.
116116

117-
![Build](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-config.png)
117+
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/09_Build.png)
118118

119119
Here, select **Add new configuration** and search for **Maven**.
120120

121-
![Add Maven Config](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-config-add.png)
121+
![Add Maven Config](/docs/02_Developer_Documentation/How-to-build-Gephi/10_Add Maven Config.png)
122122

123123
Next, we'll configure two things here. Enter `nbm:cluster-app nbm:run-platform` into the **Command line** field and select the `modules/application` sub-directory into the **Working directory** chooser. Give Gephi as name for the configuration.
124124

125-
![Set Maven Config](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-set-config.png)
125+
![Set Maven Config](/docs/02_Developer_Documentation/How-to-build-Gephi/11_Set Maven Config.png)
126126

127127
Finally, you can run Gephi by selecting **Run > Run 'Gephi'** from the top-level menu.
128128

129-
![Run](https://github.com/gephi/gephi/raw/gh-pages/wiki/build/intellij-run.png)
129+
![Run](/docs/02_Developer_Documentation/How-to-build-Gephi/12_Run.png)
130130

131131
### Troubleshooting
132132

docs/04_Plugins/Add-a-module-panel.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Add a module panel
55

66
How to create a panel for plugin features, similar to Ranking, Graph or Layout? It is easy and fully integrated in Netbeans. Create your panel class and use Netbeans IDE to design the user interface. This page also explains how to work with the **Perspective** system.
77

8-
![800px-add-module-panel](https://cloud.githubusercontent.com/assets/197285/5654096/550bf4b8-96c0-11e4-8d36-ad29c6502ce2.png)
8+
![800px-add-module-panel](/docs/04_Plugins/Add-a-module-panel/00_800px-add-module-panel.png)
99

1010

1111
- **Step 1**: Right click on your module and select **New > Other...** and find **Window** like showed in the step 1 below. The window wizard asks where to put your panel. You can use already defined modes (i.e. positions):
@@ -16,19 +16,19 @@ How to create a panel for plugin features, similar to Ranking, Graph or Layout?
1616
* filtersmode: Bottom Right
1717
* contextmode: Top Right
1818

19-
![add-module-panel1](https://cloud.githubusercontent.com/assets/197285/5654098/5513e1fa-96c0-11e4-9a39-7184440b235d.png)
19+
![add-module-panel1](/docs/04_Plugins/Add-a-module-panel/01_add-module-panel1.png)
2020

2121
- **Step 2**: Then check options about the panel policy showed in step2 and click on **Next**.
2222

23-
![add-module-panel2](https://cloud.githubusercontent.com/assets/197285/5654094/55098340-96c0-11e4-9b1c-0847e2c2e1c0.png)
23+
![add-module-panel2](/docs/04_Plugins/Add-a-module-panel/02_add-module-panel2.png)
2424

2525
- **Step 3**: Fill the **Class Name**, the system shows which files are created. Your panel is a **TopComponent** subclass.
2626

27-
![add-module-panel3](https://cloud.githubusercontent.com/assets/197285/5654095/550bbc96-96c0-11e4-8ec7-8bff84992453.png)
27+
![add-module-panel3](/docs/04_Plugins/Add-a-module-panel/03_add-module-panel3.png)
2828

2929
- **Step 4**: Click on **Finish**, files are created and you're invited to design your panel with Netbeans editor.
3030

31-
![add-module-panel-design](https://cloud.githubusercontent.com/assets/197285/5654097/55119652-96c0-11e4-96b1-fbdedf704298.png)
31+
![add-module-panel-design](/docs/04_Plugins/Add-a-module-panel/04_add-module-panel-design.png)
3232

3333
Your panel is now created and automatically registered. Start Gephi with your plugin and your panel is visible.
3434

0 commit comments

Comments
 (0)