{"_id":"58f5d5cf914540250034e4bf","project":"55faf11ba62ba1170021a9a7","parentDoc":null,"user":"5767bc73bb15f40e00a28777","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":37,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"category":{"_id":"58f5d52d7891630f00fe4e77","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-04-18T08:58:21.978Z","from_sync":false,"order":31,"slug":"data-cruncher","title":"DATA CRUNCHER (ADVANCE ACCESS)"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-18T09:01:03.544Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Heads Up!\",\n  \"body\": \"This page documents the Advance Access version (think \\\"beta\\\" but with fewer bugs) of the Data Cruncher.\"\n}\n[/block]\nThe files available in any Data Cruncher analysis belong to one of the following two types:\n* **Analysis files** - Files produced during the analysis or added to the analysis, including notebook files (**.ipynb**). These files appear under the **Files** tab in the analysis editor.\n* **Project files** - Files from the project within which the analysis is being executed. These files appear under the **Project Files** tab in the analysis editor.\n\n## Analysis files\n\nAnalysis files can be added to an analysis in one of the following ways:\n* Uploaded to the analysis directly from the local machine.\n* Downloaded into the analysis directly from a location on the Internet (using **curl** or **wget** in the notebook, for example).\n* Created by clicking the **+** icon in the top-left corner, next to the **Files** tab.\n* Produced by the code that is executed in the notebook.\n\nAll files that are created or added in a single run of an analysis are displayed under the **Files** tab in the editor.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e50fa5f-cruncher_files_list.png\",\n        \"cruncher_files_list.png\",\n        768,\n        482,\n        \"#ececec\"\n      ]\n    }\n  ]\n}\n[/block]\nThe list shows the following files:\n* Files that will be saved automatically when the analysis is stopped and loaded as analysis files the next time you start the same analysis. These files match the automatic saving criteria defined in analysis configuration.\n* Files that will not be saved automatically when the analysis is stopped. These files do not match the automatic saving criteria and are labelled in gray. Once the analysis is stopped, the files will be lost. However, you can still save them as project files manually by right-clicking and selecting **Save To Project**.\nAs analysis files are stored in the same directory as the notebook file, to reference an analysis file in your code, simply use its file name.\n\n## Project files\nProject files are the main focus of an analysis and the reason why Data Cruncher was integrated into the CGC. Thanks to their availability in the editor environment, you can easily reference the files in your code. The **Project Files tab** in the editor lists all files that are present in the project within which you are executing your analysis.\n\nAt the top of the list, there is a search box that allows you to show only project files that match the search criteria. **(1)**\n\nTo reference a project file in your code, you will need to use the full path to the file. The path can be obtained by simply clicking the file in the list, which will copy the path to the clipboard, and pasting the path at the desired place in your code. **(2)** \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/77f6fc8-cruncher_files.png\",\n        \"cruncher_files.png\",\n        1235,\n        676,\n        \"#edecec\"\n      ]\n    }\n  ]\n}\n[/block]\n## Save analysis files\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that file saving takes place only while the analysis is being stopped. When you click **Stop**, this will trigger the saving process and the analysis status will change to **SAVING**. Once saving has been completed, the analysis status changes to **SAVED**.\"\n}\n[/block]\nOne of the most important aspects of an analysis on the CGC is saving of necessary files produced by the analysis and being able to use them when you restart the same analysis, or when you create a new one within the same project.\n\nAnalysis files can be saved in two ways:\n* Automatically saved as analysis files, if they match the file saving criteria. Files that are saved in this way are loaded automatically when the analysis is started again, but will not be available under the **Files** tab inside the project to which the analysis belongs. These files will also not be available in other analyses that belong to the same project.\n* Manually saved as project files. To save a file manually, you need to right-click it in the list under the **Files** tab in analysis editor and select **Save To Project**. Once the saving process is completed at the end of an analysis run, these files will be available under the **Files** tab in the project to which the analysis belongs.","excerpt":"","slug":"about-files-in-a-data-cruncher-analysis","type":"basic","title":"About files in a Data Cruncher analysis"}

About files in a Data Cruncher analysis


[block:callout] { "type": "danger", "title": "Heads Up!", "body": "This page documents the Advance Access version (think \"beta\" but with fewer bugs) of the Data Cruncher." } [/block] The files available in any Data Cruncher analysis belong to one of the following two types: * **Analysis files** - Files produced during the analysis or added to the analysis, including notebook files (**.ipynb**). These files appear under the **Files** tab in the analysis editor. * **Project files** - Files from the project within which the analysis is being executed. These files appear under the **Project Files** tab in the analysis editor. ## Analysis files Analysis files can be added to an analysis in one of the following ways: * Uploaded to the analysis directly from the local machine. * Downloaded into the analysis directly from a location on the Internet (using **curl** or **wget** in the notebook, for example). * Created by clicking the **+** icon in the top-left corner, next to the **Files** tab. * Produced by the code that is executed in the notebook. All files that are created or added in a single run of an analysis are displayed under the **Files** tab in the editor. [block:image] { "images": [ { "image": [ "https://files.readme.io/e50fa5f-cruncher_files_list.png", "cruncher_files_list.png", 768, 482, "#ececec" ] } ] } [/block] The list shows the following files: * Files that will be saved automatically when the analysis is stopped and loaded as analysis files the next time you start the same analysis. These files match the automatic saving criteria defined in analysis configuration. * Files that will not be saved automatically when the analysis is stopped. These files do not match the automatic saving criteria and are labelled in gray. Once the analysis is stopped, the files will be lost. However, you can still save them as project files manually by right-clicking and selecting **Save To Project**. As analysis files are stored in the same directory as the notebook file, to reference an analysis file in your code, simply use its file name. ## Project files Project files are the main focus of an analysis and the reason why Data Cruncher was integrated into the CGC. Thanks to their availability in the editor environment, you can easily reference the files in your code. The **Project Files tab** in the editor lists all files that are present in the project within which you are executing your analysis. At the top of the list, there is a search box that allows you to show only project files that match the search criteria. **(1)** To reference a project file in your code, you will need to use the full path to the file. The path can be obtained by simply clicking the file in the list, which will copy the path to the clipboard, and pasting the path at the desired place in your code. **(2)** [block:image] { "images": [ { "image": [ "https://files.readme.io/77f6fc8-cruncher_files.png", "cruncher_files.png", 1235, 676, "#edecec" ] } ] } [/block] ## Save analysis files [block:callout] { "type": "info", "body": "Please note that file saving takes place only while the analysis is being stopped. When you click **Stop**, this will trigger the saving process and the analysis status will change to **SAVING**. Once saving has been completed, the analysis status changes to **SAVED**." } [/block] One of the most important aspects of an analysis on the CGC is saving of necessary files produced by the analysis and being able to use them when you restart the same analysis, or when you create a new one within the same project. Analysis files can be saved in two ways: * Automatically saved as analysis files, if they match the file saving criteria. Files that are saved in this way are loaded automatically when the analysis is started again, but will not be available under the **Files** tab inside the project to which the analysis belongs. These files will also not be available in other analyses that belong to the same project. * Manually saved as project files. To save a file manually, you need to right-click it in the list under the **Files** tab in analysis editor and select **Save To Project**. Once the saving process is completed at the end of an analysis run, these files will be available under the **Files** tab in the project to which the analysis belongs.