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
Copy file name to clipboardexpand all lines: README.md
+28-52
Original file line number
Diff line number
Diff line change
@@ -32,14 +32,16 @@ If you happen to mention or use this project as part of one of your scientific w
32
32
To start developing this project, please complete the following steps:
33
33
34
34
1. Install docker on your local machine
35
-
2. Install python 3.7 or higher on your local machine
36
-
3. Clone the CSX project to your machine
37
-
4. Start docker
38
-
5. In a terminal, navigate to the project directory and run `docker-compose up`, which will start the app in development mode.
39
-
6. Once the project is running, it will be accessible on [http://localhost:8882](http://localhost:8882)
40
-
7. Before you can start exploring the example dataset, open another terminal and navigate to the `datasets_example` folder in the project folder
41
-
8. Run the following command in python `python populate_elastic.py jucssm jucs_sm.ndjson` to populate the CSX storage with the sample dataset
42
-
9. Refresh your browser page and start exploring
35
+
2. Clone the CSX project to your machine
36
+
3. Start docker
37
+
4. In a terminal, navigate to the project directory and run `docker-compose up`, which will start the app in development mode.
38
+
5. Once the project is running, it will be accessible on [http://localhost:8882](http://localhost:8882)
39
+
6. Before you can start exploring the example dataset, open `datasets_example` folder and drag and drop the example file `just_sm.csv` into the csx drop zone.
40
+
7. Rename the dataset name to jucssm
41
+
8. Set `Title` as the anchor and default search column (click on the radio button in the first column and the checkbox in the third column)
42
+
9. Set `Authors` as the link (click on the radio button in the second column)
43
+
10. Click set defaults
44
+
11. After a short period the dataset should be ready for exploration
43
45
44
46
## Usage 🤔
45
47
Here is an example video showing how to use CSX once the example data has been loaded. It can be roughly divided into the following sections:
@@ -62,50 +64,24 @@ Once you are happy with your implementation, open a pull request to the develop
62
64
## Developing 🧑💻
63
65
### Starting the project and populating elastic with the sample dataset
64
66
65
-
Run `docker-compose up`, which will start the app in development mode.
66
-
67
-
Navigate to the `dataset_examples` in your terminal and run the following command to populate the running elastic instance with sample data collected from the [Journal of Universal Computer Science](https://lib.jucs.org/): `python populate_elastic.py jucssm jucs_sm.ndjson`. The first argument is the index name, and the second argument is the file name.
68
-
69
-
You can drop your custom dataset in the same folder and run the command by changing the parameters for the index name and the file name. The custom dataset should have the following format:
A file containing the config for this dataset can be found in the `server/app/data/config` folder. This file can be used to modify your default config for the uploaded dataset. If you add more datasets, please make sure to name the config file of each new dataset the same as the index. **Dataset config files are necessary for each dataset!**
79
-
80
-
The config file has the following parameters:
81
-
```JavaScript
82
-
{
83
-
"default_visible_dimensions": ["feature 1", "feature 2"], // Default visible features in detail network
84
-
"anchor":"featur 2", // Default anchor node for both networks
85
-
"links": ["feature 1"], // Default link features for both networks
86
-
"default_search_fields": ["feature 2"], // Features used for searching through the start page searchbar
87
-
"schemas": [ // Default schemas (can be left empty)
88
-
{
89
-
"name":"schema name",
90
-
"relations": [
91
-
{
92
-
"dest":"feature 1",
93
-
"src":"feature 2",
94
-
"relationship""oneToOne"// Can be oneToOne, oneToMany, ManyToOne and manyToMany
95
-
},
96
-
{
97
-
"dest":"feature 2",
98
-
"src":"feature 3",
99
-
"relationship""oneToMany"
100
-
}
101
-
]
102
-
}
103
-
]
104
-
}
105
-
```
106
-
107
-
108
-
Open [http://localhost:8882](http://localhost:8882) to view CSX in the browser and explore the newly added dataset.
67
+
Run `docker-compose up`, which will start the app in development mode on [http://localhost:8882](http://localhost:8882)
68
+
69
+
Navigate to the `dataset_examples` folder and drag and drop the example file `just_sm.csv` into the csx drop zone to populate the running elastic instance with sample data collected from the [Journal of Universal Computer Science](https://lib.jucs.org/).
70
+
71
+
72
+
To add a custom dataset simply prepare a CSV file with the following format (make sure there are no single quotation marks in the text since that might interfere with the automatic processing of list values):
73
+
74
+
| String feature name | Category feature name | Number feature name | List feature name |
| Some string value. | Categorical val 1 | 1 |["val1","val2","val3"]|
77
+
| Another string value | Categorical val 2 (same as a string) | 4.35 |["val6","val4","val1"]|
78
+
79
+
80
+
When the dataset is uploaded a config file is created in the `server/app/data/config` folder. This file defines the default configuration for a dataset.
81
+
82
+
> 🚨 **Config files should never be manually modified. If you want to modify the config of a dataset either click on the change default settings for dataset button next to each of the datasets on the homepage or delete the dataset and upload it again with different settings.**:
0 commit comments