How to Submit an Export Request

Export Guidelines

Please read the export guidelines carefully and make sure your code and the material (files, tables, graphs, etc.) which you want to export is in compliance with it. You can find the export guidelines here. Once the material you want to export is ready you can initiate an export request. There are three steps, detailed below, which you will need to complete to submit an export request: (1) prepare your export request, (2) submit your export request, and (3) create a merge request on GitLab for your export request. You will find two icons on your desktop "PrepareExport" and "SubmitExport".

Prepare Export

Start your export by clicking on the "PrepareExport" icon on your desktop. This will open following terminal window:

The window will display all the projects you are a member of. Please select the project you want to export files for. You can see all your projects listed with a number. Please type in the number associated with the project you want to export files for and press enter. The script will clone your export repository (if necessary) and generate a new branch for the export which has the name "export-username-date". The export folder is located in your home directory. You will have one folder for each project. You will find two subfolders "input" and "output" in the export folder.

Now you can drag and drop the files you want to export in the corresponding folders (see export guidelines):

• Input folder: please save all files you used to create the files you are asking to export. This includes all code files and any other documentation you want to provide with your results.
• Export folder: all files that you want to export go in this folder. Any format is allowed. Please remember that if you request graphs we need a csv or txt file showing the numbers behind the graph. If you want to export a juypter notebook please clear any data in the notebook before exporting.

When you are done with copying the files needed for the export you can close the windows and submit the export by running "SubmitExport".

Submit Export

After preparing the export you need to click on the icon "SubmitExport" which will open following terminal window for you:

As in the export preparation you will have to make a decision for which project you want to submit the request. Enter the number associated with the project you want to submit. Then you will be asked to enter your user name and password for GitLab.

After entering your GitLab account info your export request will be pushed to the respective project export folder and GitLab will open so you can complete the export. The export request is labeled with "export-username-date".

Merge Request

In order to complete your export request and notify ADRF you need to submit a merge request through GitLab. The following screenshots will walk you through the submission of a merge request.

1. Create a New Merge Request

GitLab will open directly on the merge request tab. Please always click "New Merge Request", not the blue box which says Create Merge Request.

2. Select the Correct Branches

Now you have to select the source and target branch.

• The source branch field on the left shows the name of your export project repository. The right field shows the export you submitted. If you click on it it will open a drop down menu. Please select the most recent submission you want to export ("export-username-date").
• The target branch field on the left should display the same project repository as in the source branch field. Master should be selected on the right field.

Please make sure that you selected the correct branches before you click "Compare branches and Continue".

3. Fill out the Form and Submit the Request

Now you can complete the export form and click "Submit Merge Request":

• Title: Please fill in the title with "export-username-date"
• Description: Please provide us with a description of what you are exporting. The more details you provide the easier it is to understand what you did in your analyses. Think about the information someone who is not familiar with your project needs to know to understand your research.
• Assignee/Milestones/Labels: You can leave these fields as they are
• Source branch: Should be the branch that you submitted for export ("export-username-date")
• Target branch: Please make sure that master is selected.

Approval of Export Request

Now the export was submitted. The ARDF will be in touch with you and send you a download link if your export is approved. The export request will be protected and you can not make any changes to this export request. If you need more output you need to submit a new export request following the outlined procedure.

Amendment of Export Request

In case your export is not approved the ADRF staff will contact you and ask you to make the appropriate changes and submit an amendment to your existing export request. You can make the requested changes and drag and drop the changed file in the export folder associated with the export. Then click the "SubmitExport" icon and submit a new merge request as outlined. You do not have to run "PrepareExport" for resubmissions.

We will try to make export turnaround as fast as possible, but in order to do that, it will be necessary to keep the number of the export requests to a minimum.