User Tools

Site Tools


01_user_documentation:05_object:04_data:01_dataset

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
01_user_documentation:05_object:04_data:01_dataset [2025/01/30 12:07] – created gaetan01_user_documentation:05_object:04_data:01_dataset [2025/09/05 17:20] (current) – ↷ Links adapted because of a move operation gaetan
Line 1: Line 1:
 ====== Dataset  ====== ====== Dataset  ======
  
-It create in memory datasets.+GroIMP supports the creation and visualization of datasets, which are simple tables used to store and track numerical data during simulations. Each dataset consists of rows called data series, and values are added to individual cells using code. 
 + 
 +======  ====== 
 + 
 + 
 +Datasets are accessible in both the GUI (via the [[01_user_documentation:03_interacting_with_groimp:02_panels:02_explorers:03_datasets|Datasets Explorer]]) and in RGG code using the DatasetRef class. 
 + 
 +Titles for columns can be set, and data can be [[01_user_documentation:03_interacting_with_groimp:15_visualization:04_plotting|plotted]]. 
 + 
 +Datasets are persistent across simulation runs unless explicitly cleared. 
 + 
 +===== Export ===== 
 + 
 +Using the [[01_user_documentation:03_interacting_with_groimp:02_panels:02_explorers:03_datasets| explorer]] datasets can be exported to: 
 + 
 +  * txt 
 +  * csv 
 +  * html 
 +  * xls 
 +  * pdf 
 + 
 +Using rgg code datasets can be exported to csv with the [[ 01_user_documentation:05_object:06_references:03_datasets#exporting | export function]]. 
 + 
 + 
 +For code examples see the [[02_user_tutorials:data_plots|datasets tutorial]]. 
 + 
 +===== Cleaning ===== 
 + 
 +Since datasets are persistent across simulation runs old data is kept inside. A dataset can be clean using the  datasetRef function [[01_user_documentation:05_object:06_references:03_datasets#cleaning|''clear()'']] or by simply deleting the object form the dataset explorer.  
 + 
 + 
 +===== Adding data ===== 
 + 
 +The only way to add values to a dataset is through RGG code executed either in the model or in the xl console, using the [[01_user_documentation:05_object:06_references:03_datasets#adding_data | datasetRef functions]].  
 +  
 + 
 +==== adding multipe values for one cell ==== 
 + 
 +In order to use the [[01_user_documentation:03_interacting_with_groimp:15_visualization:04_plotting:07_xy_plot]] or the [[01_user_documentation:03_interacting_with_groimp:15_visualization:04_plotting:06_scatter_plot]] more than one value per cell is needed. Therefore the datasetRef has [[01_user_documentation:05_object:06_references:03_datasets#add_several_values_to_one_cell |additional functions]] for that and in the table view this is displayed with white spaces. 
 + 
01_user_documentation/05_object/04_data/01_dataset.1738235253.txt.gz · Last modified: 2025/01/30 12:07 by gaetan