/
File format for Open DEM

File format for Open DEM

Driver

@Bruno Chareyre

Approver

@Daniel Barreto

Contributors

@John P. Morrissey @Bruno Chareyre @Adrian Priceputu Ulrich Odefey

Informed

Objective

part of this task will be our first deliverable - D1. Enumerating data to save (month 12) and is crucial for achieving all the objectives of our WG

Due date

Sep 4, 2024 - this is just before our next WG meeting in Edinburgh

Key outcomes

  • list of numerical data to be included in the Open DEM file format

  • framework for storing necessary data for saving / reloading simulations

  • setup a normalized way for storing data types, so that it can be expanded for various contact models and simulation codes

Status

not started / in progress / complete

 

 Initial thoughts

At our first meeting, in Helsinki, it was decided that we need to display a hierarchy of data with normalized names in order to export / import simulations from one code to another.

Some data will be flagged as “mandatory” – needed for saving the simulation – while other will be flagged as “optional” – this is used for post-processing only.

A sketch of this framework (as discussed during the meeting) is shown below:

data framework sketch rev2-20240831-081549.png

 

Progress

A first proposal for a framework for shaping and displaying the data structure (this is more of an example, to show how it can be done, and will be updated):
https://gricad-gitlab.univ-grenoble-alpes.fr/on-dem/model-data

The data structure can be visualised in HTML or PDF file format.

PROS:

  • the data is separated from the display (the style of the pdf/html can be changed)

  • revisions can be viewed and discussed before accepted (they’ll be on a different branch)

  • editing can be done in browser

  • the data structures are defined as python classes (and the output is generated with sphinx), so the open format is also defined in a way that can be used in computer programs

CONS:

  • each contributor needs to register an account on Gricad gitlab (we might migrate though)

  • the python format should be strictly followed (a misplaced indentation would break)

Anyone can register an account on gricad-gitlab (“standard” tab), then email bruno.chareyreA3sr-grenoble.fr for an invitation to the gitlab project.

 

 Scope

Must have:

  •  

Must have:

  •  

Nice to have:

  •  

Not in scope:

  •  

 

 Timeline

 

 Milestones and deadlines

Milestone

Owner

Deadline

Status

Milestone

Owner

Deadline

Status

 

 

 

 

 

 

 

 

 

 Reference materials