Difference between revisions of "Workflow:How to preserve your 3D data with the French National 3D Repository?"

	How to preserve your 3D data with the French National 3D Repository?
Status:	Draft
Tools:	CND3D; ALTAG3D; FileZilla;
Input:	All data identified as to be retained in the 3D data life cycle
Output:	A SIP stored in the French National 3D Repository (Conservatoire National des Données 3D)
Organisation:	Consortium "3D for Humanities"

Revision as of 08:16, 24 February 2022

Workflow Description

There are two ways to create a deposit on the CND3D - the final objective being to keep the data on the servers of the French National 3D Data Repository (Conservatoire National des Données 3D aka CND3D).

Online deposit: creation of a deposit with general information (deposit metadata) and as many 3D objects as needed (with their metadata).
Offline deposit: creation of a SIP with aLTAG3D tool to be installed on the depositor's computer (see aLTAG3D for more information).

First method (online SIP's creation)

Step 1: fill in the forms

Fill in the general desposit form
Fill in as many 3D object forms as 3D object in the deposit
Add interoperable thesaurus tag to enrich each 3D object information

Step 2: Upload the files corresponding to the deposit
Use an sftp tool like fileZilla to upload the files to the CND3D server, to the appropriate folder (one folder per deposit).

Second method (offline SIP's creation)

Step 1: Create the SIP on user's computer (see aLTAG3D tool for more information)

Identify the data you want to preserve (see 3D data life cycle for more information)
Open aLTAG3D, create a new project and save it on your working folder (probably in the folder of the 3D data you want to preserve)
1. If you are using the software for the first time, it may be necessary to activate all plugins
A tree structure of nodes appears. Each box corresponds to a type of information.
1. By selecting a box, the metadata appears in the side panel on the right. All required information is framed in red; other information is optional. When information is entered, the red box turns green. The aim of the game is that all boxes turn green to generate the SIP.
2. If a node is pulled, a new box is added. Depending on the data to be stored, it is possible to customize the output.
You can drag and drop the files to be preserved on the box, a huge amount of technical metadata is automatically extracted. You only have to fill a little amount of information.
Verify the integrity of the project.
You can generate a rapport of the project ready to be exported
You can proceed to the creation of the SIP. A few extra information are required, and the the software will copy every files in a new folder, and create some xml file containing metadatas

Step 2: Upload the SIP
Upload the complete SIP to the CND3D servers to the appropriate folder (one folder per SIP) via the SFTP protocol. Filezilla can be used.

Prerequisites

To be able to make a deposit, the depositor must register to the CND3D with its official academic filiation (French Research Institution/University) created as the depositor's entity.
An account with a login is then created for the new depositor.
All official depositor's entities can be listed in CND3D's home page

Advantages

All deposits of the CND3D have a DOI and each 3D object also has a DOI: any 3D object in the CND3D ( or any deposit) can be quoted in a scientific publication.
Collection of 3D objects can be created to reconstitute an existing collection or create a virtual collection, see an example with la Technothèque.
3D objects in the CND3D can be exported in online visualisable format to be exposed in a 3D online viewer.

Purpose

This workflow is designed to preserve 3D data produced in the framework of cultural heritage documentation, and to semantically enrich them so that they can be harvested by other French, European or International ecosystems.

Context

The concepts of archiving and preservation of digital data should not be confused. Preservation implies that data is stored and populated with a set of metadata on a medium. Archiving brings an additional constraint: as file formats evolve, the files must also be updated to ensure the long-term readability of the content. This costly operation can only be done if the file format is documented and has a validator. As a consequence, only a few file formats can be accepted. Preservation, on the other hand, means keeping the files as they were received, without maintaining the file formats, which is a lighter solution. Although there is no obligation concerning the file formats that can be deposited, we can only recommend that the most universal possible formats be used, which are documented and can be opened with software that is accessible in the medium term.

Preserving files does not only mean putting them on a server or a hard disk, as several dangers can arise. Over time, one can forget that they exist. Then, one can also forget how they were produced, for what purpose. This is important information that allows you to have confidence in the data: this is a key aspect in the reuse of data for scientific research. All this information should be transcribed in the form of metadata. The main advantage of the proposed workflow (compared to archiving) is to format the information so that it can be recognized by the tools developed by the French National 3D Data Repository (aka "Conservatoire National des Données 3D / CND3D") and several other search engines (Isidore, ARIADNE+ and GoTriple) when it will be in place. Thus, from a single point of deposit, data can be retrieved on other platforms.

Evaluation and Review

The workflow has been extensively tested since 2016 by members of the 3D SHS Consortium, and is regularly improved. For any questions or suggestions, please contact contact@humanities.science

Further Information

For an extensive documentation about the scheme of metadata behind aLTAG3D and the National 3D Repository (in French):

Dutailly B., Eusèbe S., Grimaud V., Lefèvre N., Quantin M., Tournon S., 2019. L’archivage pérenne des modèles numériques 3D pour les SHS. Consortium 3D SHS, dir. Granier X. hal-02195914

For a more detail approach of the workflow (in French):

Tournon S., Grimaud V., Dutailly B., Granier X., 2020. Le Conservatoire National des Données 3D SHS. Humanistica 2020, May 2020, Bordeaux, France. hal-02733470

@@ Line 1: / Line 1: @@
 {{Infobox COW
 |status=Draft
-|tools=aLTAG3D, CND3D
+|tools=CND3D, aLTAG3D, FileZilla
 |input=All data identified as to be retained in the [https://coptr.digipres.org/index.php/Workflow:Life_Cycle_of_3D_Data_for_Cultural_Heritage 3D data life cycle]
 |output=A SIP stored in the French National 3D Repository (Conservatoire National des Données 3D)
 |organisation=Consortium "3D for Humanities"
-|organisationurl=https://shs3d.hypotheses.org/
+|organisationurl=https://3dhumanities.hypotheses.org/
 }}
 ==Workflow Description==
-There are two ways to create a repository on the CND3D - the final objective being to keep the data on the servers of the National 3D Data Conservatory.
+[[File:WorkflowCND3D.png|550px|thumb]]
-- Either the files are loaded directly from the web browser, and all the metadata must then be filled in one by one (need for Sarah's confirmation).
+There are two ways to create a deposit on the CND3D - the final objective being to keep the data on the servers of the French National 3D Data Repository (Conservatoire National des Données 3D aka CND3D).
-- Or the files are filled in through the aLTAG3D software - to be installed on the computer. The files are dragged and dropped into the interface, a large part of the metadata is then retrieved automatically, only the descriptive metadata remains to be documented. Once all the information is filled in, aLTAG3D checks the validity of the deposit, and generates a tree structure with the metadata (xml file). This package can be sent via ftp, with Filezilla for example.
+* Online deposit: creation of a deposit with general information (deposit metadata) and as many 3D objects as needed (with their metadata).
-This second option is therefore preferable because it allows better documentation of the repositories.
+* Offline deposit: creation of a SIP with aLTAG3D tool to be installed on the depositor's computer (see [https://altag3d.huma-num.fr/ aLTAG3D] for more information).
+===First method (online SIP's creation)===
+'''Step 1: fill in the forms
+# Fill in the general desposit form
+# Fill in as many 3D object forms as 3D object in the deposit
+# Add interoperable thesaurus tag to enrich each 3D object information
+'''Step 2: Upload the files corresponding to the deposit
+<br>Use an sftp tool like fileZilla to upload the files to the CND3D server, to the appropriate folder (one folder per deposit).
-<!-- To add an image of your workflow, open the "Upload File" link on the left in a new browser tab and follow on screen instructions, then return to this page and add the name of your uploaded image to the line below - replacing "workflow.png" with the name of your file. Replace the text "Textual description" with a short description of your image. Filenames are case sensitive! If you don't want to add a workflow diagram or other image, delete the line below  -->
+===Second method (offline SIP's creation)===
+'''Step 1: Create the SIP on user's computer (see [https://altag3d.huma-num.fr/ aLTAG3D tool] for more information)'''
+# Identify the data you want to preserve (see [https://coptr.digipres.org/index.php/Workflow:Life_Cycle_of_3D_Data_for_Cultural_Heritage 3D data life cycle] for more information)
+# Open aLTAG3D, create a new project and save it on your working folder (probably in the folder of the 3D data you want to preserve)
+## If you are using the software for the first time, it may be necessary to activate all plugins
+# A tree structure of nodes appears. Each box corresponds to a type of information.
+## By selecting a box, the metadata appears in the side panel on the right. All required information is framed in red; other information is optional. When information is entered, the red box turns green. The aim of the game is that all boxes turn green to generate the SIP.
+## If a node is pulled, a new box is added. Depending on the data to be stored, it is possible to customize the output.
+# You can drag and drop the files to be preserved on the box, a huge amount of technical metadata is automatically extracted. You only have to fill a little amount of information.
+# Verify the integrity of the project.
+# You can generate a rapport of the project ready to be exported
+# You can proceed to the creation of the SIP. A few extra information are required, and the the software will copy every files in a new folder, and create some xml file containing metadatas
-[[File:workflow.png|Textual description]]<br>
+'''Step 2: Upload the SIP'''
+<br>Upload the complete SIP to the CND3D servers to the appropriate folder (one folder per SIP) via the SFTP protocol. Filezilla can be used.
-<!-- Describe your workflow here with an overview of the different steps or processes involved-->
-==Purpose, Context and Content==
+===Prerequisites===
-<!-- Describe what your workflow is for - i.e. what it is designed to achieve, what the organisational context of the workflow is, and what content it is designed to work with -->
+To be able to make a deposit, the depositor must register to the CND3D with its official academic filiation (French Research Institution/University) created as the depositor's entity.
+<br>An account with a login is then created for the new depositor.
+<br>All official depositor's entities can be listed in [https://3d.humanities.science/ CND3D's home page]
-==Evaluation/Review==
+===Advantages===
-<!-- How effective was the workflow? Was it replaced with a better workflow? Did it work well with some content but not others? What is the current status of the workflow? Does it relate to another workflow already described on the wiki? Link, explain and elaborate -->
+All deposits of the CND3D have a DOI and each 3D object also has a DOI: any 3D object in the CND3D ( or any deposit) can be quoted in a scientific publication.
+<br>Collection of 3D objects can be created to reconstitute an existing collection or create a virtual collection, see an example with [https://3d.humanities.science/collection/Technothèque la Technothèque].
+<br>3D objects in the CND3D can be exported in online visualisable format to be exposed in a 3D online viewer.
+==Purpose==
+This workflow is designed to preserve 3D data produced in the framework of cultural heritage documentation, and to semantically enrich them so that they can be harvested by other French, European or International ecosystems.
+==Context==
+The concepts of ''archiving'' and ''preservation'' of digital data should not be confused. Preservation implies that data is stored and populated with a set of metadata on a medium. Archiving brings an additional constraint: as file formats evolve, the files must also be updated to ensure the long-term readability of the content. This costly operation can only be done if the file format is documented and has a [https://facile.cines.fr/ validator]. As a consequence, only a few file formats can be accepted. Preservation, on the other hand, means keeping the files as they were received, without maintaining the file formats, which is a lighter solution. Although there is no obligation concerning the file formats that can be deposited, we can only recommend that the most universal possible formats be used, which are documented and can be opened with software that is accessible in the medium term.
+Preserving files does not only mean putting them on a server or a hard disk, as several dangers can arise. Over time, one can forget that they exist. Then, one can also forget how they were produced, for what purpose. This is important information that allows you to have confidence in the data: this is a key aspect in the reuse of data for scientific research. All this information should be transcribed in the form of metadata. The main advantage of the proposed workflow (compared to archiving) is to format the information so that it can be recognized by the tools developed by the [https://3d.humanities.science/ French National 3D Data Repository (aka "Conservatoire National des Données 3D / CND3D")] and several other search engines ([https://isidore.science/ Isidore], [https://ariadne-infrastructure.eu/ ARIADNE+] and [https://www.gotriple.eu/ GoTriple]) when it will be in place. Thus, from a single point of deposit, data can be retrieved on other platforms.
+==Evaluation and Review==
+The workflow has been extensively tested since 2016 by members of the 3D SHS Consortium, and is regularly improved. For any questions or suggestions, please contact contact@humanities.science
 ==Further Information==
-<!-- Provide any further information or links to additional documentation here -->
+For an extensive documentation about the scheme of metadata behind aLTAG3D and the National 3D Repository (in French):
+* Dutailly B., Eusèbe S., Grimaud V., Lefèvre N., Quantin M., Tournon S., 2019. L’archivage pérenne des modèles numériques 3D pour les SHS. ''Consortium 3D SHS'', dir. Granier X. [https://hal.archives-ouvertes.fr/hal-02195914 hal-02195914]
+For a more detail approach of the workflow (in French):
+* Tournon S., Grimaud V., Dutailly B., Granier X., 2020. Le Conservatoire National des Données 3D SHS. ''Humanistica 2020'', May 2020, Bordeaux, France. [https://hal.archives-ouvertes.fr/hal-02733470/ hal-02733470]
 <!-- Add four tildes below ("~~~~") to create an automatic signature, including your wiki username. Ensure your user page (click on your username to create it) includes an up to date contact email address so that people can contact you if they want to discuss your workflow -->
-<!-- Note that your workflow will be marked with a CC3.0 licence -->

How to preserve your 3D data with the French National 3D Repository?
Status:	Draft
Tools:	CND3D ALTAG3D FileZilla
Input:	All data identified as to be retained in the 3D data life cycle
Output:	A SIP stored in the French National 3D Repository (Conservatoire National des Données 3D)
Organisation:	Consortium "3D for Humanities"