Tarring projects - Revision history

Daniel Castaño: /* Transferring data */

2017-11-06T15:47:38Z

Transferring data

Daniel Castaño at 15:46, 6 November 2017

2017-11-06T15:46:30Z

Daniel Castaño at 15:46, 6 November 2017

2017-11-06T15:46:16Z

Daniel Castaño at 08:44, 24 August 2016

2016-08-24T08:44:02Z

Daniel Castaño at 08:43, 24 August 2016

2016-08-24T08:43:27Z

Daniel Castaño at 08:42, 24 August 2016

2016-08-24T08:42:44Z

Daniel Castaño at 08:34, 24 August 2016

2016-08-24T08:34:18Z

Daniel Castaño at 08:29, 24 August 2016

2016-08-24T08:29:31Z

Daniel Castaño: Created page with "Tarring projects is the technique of compacting all information in a project in a single file (called ''tarball''). This file can be then copied to a different machine networ..."

2016-08-24T08:21:26Z

Created page with "Tarring projects is the technique of compacting all information in a project in a single file (called ''tarball''). This file can be then copied to a different machine networ..."

New page

Tarring projects is the technique of compacting all information in a project in a single file (called ''tarball''). This file can be then copied to a different machine network. to be executed there.

There are two main scenarios where you may want to tar projects
* You are using a local workstation to design projects, as the memory of the workstation gives you an immediate feedback (when, for instance, designing masks, looking at particles, etc). When all the setup work is done, the projects is to be ran in different ''remote'' machine .
* You ran a project in a remote machine where graphical operations are slow, and want to examine the results on your more powerful local machine.
* You are collaborating with other researchers. They ran a project and sent it to you so that you can examine the results.

Tarring can also be used to store into a single file all the re

Do not use the system <tt>tar</tt> command to create a tarred version of a project!!

== Differences with the system command <tt>tar</tt>==

The ''Dynamo'' command <tt>dvtar</tt> is ''not'' an exact equivalent of the system <tt>tar</tt> command. In a ''Dynamo''project, you may have linked tables,templates, and masks which are in the path of your machine, but not in the project folder. In your system, the project will look for these elements in the local file structure.

<tt>dvtar</tt> will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can move the folder to another location.

== Command line syntax ==

The full syntax description can be found here {{docfunction|dynamo_vpr_tar|dthelp}}.

<tt>dvtar myProject</tt>
will create a tarball <tt>myProject.tar</tt> which includes all linked files, but not the data.

<pre>dvtar myProject -data 1</pre>
to pass also the data

== Transferring data ==
It is possible to transfer the data inside the tarball. This is only useful when the size of the data set is rather small, probably for demonstration purposes. In real projects, you don't want to transfer around files of several Gb continuously. It is often the case that you have your data in a local location, and a copy of it in a remote location. In such cases, you will want to relink the data in the project untarred in the target machine.

This can be easily done with the <tt>dvput</tt> command:
<tt>dvput myProject -data dataInRemoteSystem</tt>
where <tt>nameOfDataInRemote</tt> is the name of the data folder in the remote machine.

← Older revision		Revision as of 15:46, 6 November 2017
Line 14:		Line 14:

	<tt>dvtar</tt>, on the other hand, will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can safely move the full structure to another location. After transferring the tarball to a remote location, you can use <tt>dvuntar</tt> to recreate the project in the remote machine.		<tt>dvtar</tt>, on the other hand, will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can safely move the full structure to another location. After transferring the tarball to a remote location, you can use <tt>dvuntar</tt> to recreate the project in the remote machine.
−
−

	== Command line syntax ==		== Command line syntax ==

@@ Line 19: / Line 19: @@
 == Command line syntax ==
-The full syntax description can be found here {{docfunction|dynamo_vpr_tar|dvtar}}.
+The full syntax description can be found in {{docfunction|dynamo_vpr_tar|dvtar}}.
 '''In the local machine:'''
 <pre>dvtar myProject</pre>
-will create a tarball <tt>myProject.tar</tt> which includes all linked files, but not the data.
+will create a tarball <tt>myProject.tar</tt> which includes all linked files, but [[#Transferring data | not the data]].
 <pre>dvtar myProject -data 1</pre>

@@ Line 13: / Line 13: @@
 In a ''Dynamo''project, you may have linked files ad directories (representing tables, templates, and masks) which are in the path of your machine, but not in the project folder. In your system, during runtime the project will look for these elements in the local file structure. Thus, just planting the project folder structure in a different environment (as the OS command <tt>tar</tt> would do) will fail.
-<tt>dvtar</tt>, on the other hand,  will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can safely move the folder to another location.
+<tt>dvtar</tt>, on the other hand,  will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can safely move the full structure to another location. After transferring the tarball to a remote location, you can use <tt>dvuntar</tt> to recreate the project in the remote machine.
@@ Line 19: / Line 19: @@
 == Command line syntax ==
-The full syntax description can be found here {{docfunction|dynamo_vpr_tar|dthelp}}.
+The full syntax description can be found here {{docfunction|dynamo_vpr_tar|dvtar}}.
 <pre>dvtar myProject</pre>
@@ Line 26: / Line 28: @@
 <pre>dvtar myProject -data 1</pre>
 to pass also the data
 == Transferring data ==

@@ Line 9: / Line 9: @@
 == Differences with the system command <tt>tar</tt>==
-Do not use the system <tt>tar</tt> command to create a tarred version of a project!! While their functionalities are similar they do '''not'''work the same way.
+Do not use the system <tt>tar</tt> command to create a tarred version of a project!! While their functionalities are similar they do '''not''' work the same way.
- In a ''Dynamo''project, you may have linked  tables,templates, and masks which are in the path of your machine, but not in the project folder. In your system, the project will look for these elements in the local file structure.
+In a ''Dynamo''project, you may have linked files ad directories (representing tables, templates, and masks) which are in the path of your machine, but not in the project folder. In your system, during runtime the project will look for these elements in the local file structure. Thus, just planting the project folder structure in a different environment (as the OS command <tt>tar</tt> would do) will fail.
-<tt>dvtar</tt> will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can move the folder to another location.
+<tt>dvtar</tt>, on the other hand,  will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can safely move the folder to another location.

@@ Line 34: / Line 34: @@
 This can be easily done with the <tt>dvput</tt> command:
-<tt>dvput myProject -data dataInRemoteSystem</tt>
+ <tt>dvput myProject -data dataInRemoteSystem</tt>
-where <tt>nameOfDataInRemote</tt> is the name of the data folder in the remote machine.
+where <tt>nameOfDataInRemote</tt> is the name of the data folder in the remote machine. Remember to unfold your project after changing parameters inside it:

@@ Line 5: / Line 5: @@
 * You ran a project in a remote machine where graphical operations are slow, and want to examine the results on your more powerful local machine.
 * You are collaborating with other researchers. They ran a project and sent it to you so that you can  examine the results.
 == Differences with the system command <tt>tar</tt>==
@@ Line 29: / Line 28: @@
 '''In the remote machine:'''
 <pre>dvuntar myProject </pre>
 == Transferring data ==

@@ Line 1: / Line 1: @@
 Tarring projects is the technique of compacting all information in a  project in a single file (called ''tarball''). This file can be then copied to a different machine network. to be executed there.
-There are two main scenarios where you may want to tar projects
+There are several main scenarios where you may want to tar projects
 * You are using a local workstation to design projects, as the memory of the workstation gives you an immediate feedback (when, for instance, designing masks, looking at particles, etc). When all the setup work is done, the projects is to be ran in different ''remote'' machine .
 * You ran a project in a remote machine where graphical operations are slow, and want to examine the results on your more powerful local machine.
@@ Line 7: / Line 7: @@
-Tarring can also be used to store into a single file all the re
+== Differences with the system command <tt>tar</tt>==
-Do not use the system <tt>tar</tt> command to create a tarred version of a project!!
+Do not use the system <tt>tar</tt> command to create a tarred version of a project!! While their functionalities are similar they do '''not'''work the same way.
-The ''Dynamo'' command <tt>dvtar</tt> is ''not'' an exact equivalent of the system <tt>tar</tt> command. In a ''Dynamo''project, you may have linked  tables,templates, and masks which are in the path of your machine, but not in the project folder. In your system, the project will look for these elements in the local file structure.
+ In a ''Dynamo''project, you may have linked  tables,templates, and masks which are in the path of your machine, but not in the project folder. In your system, the project will look for these elements in the local file structure.
 <tt>dvtar</tt> will make copies of all the linked files into the project folder, and will direct the project to look for the elements (tables, templates, etc....) in their location relative to the project folder. This way you can move the folder to another location.
@@ Line 23: / Line 21: @@
 The full syntax description can be found here {{docfunction|dynamo_vpr_tar|dthelp}}.
-<tt>dvtar myProject</tt>
+<pre>dvtar myProject</pre>
 will create a tarball <tt>myProject.tar</tt> which includes all linked files, but not the data.