Quick Start Guide
11 min
this guide will provide a simple workflow for starting the amics reports and loading amics data into the project management system it will also provide basic instructions on setting up dashboards and report templates however, users should read through the more advanced sections to become fully informed about using this application amics reports can be started from the windows start menu or manually run the signed executable the first time the application loads, files will need to be set up for future use so that the initial load time will be longer than usual however, this will only occur for the first time run on a system once loaded, the default initial interface will look like this this interface is divided into several sections, providing access to four main functional groups within amics reports (see image below) later sections of this manual provide further details on the interface connecting data to connect to an data source, click the " connect " option in the reports interface's main menu and ribbons section this will bring up a standard windows folder dialog, allowing the users to select a folder containing the designed data once a folder is selected, the reports will show the folder in the " data source " subpanel in the data interface panel the imported folder will contain all the subfolders and will allow access to relevant data types within any subfolders (i e , spark json or csv ) note! amics reports does not copy or move any data, and the data source represents a pointer to the existing folder location this ensures the reports do not disturb the user's folder data structures still, it also means moving data in windows will break the amics reports' connection and invalidate the data source supported formatrs the system can funcation with the following file format csv spark josn with and without inditation spark bin spark binary file with and without inditation json x y locaiton file from hitachi ft230 tiff jpeg bmp png additional file formats can be added upon requies as part of special project parsing a csv file csv files must be parsed to be imported into the system and used connect to a folder (see above) make a new folder or use an existing folder without an attached data model drag the csv file into the folder this will open the parsing window designate the header rows and data starting rows (a) if data if from a hitachi ft230 connect the csv file to the json positions with the import positions option (b) if the csv contines many measurements as rows sleect "split" to import the csv with each row as an expiriment (c) this will allows the uset to move the infomration (expiriments) logically in the project managment system without having to seperate the data into diffrent physical files select the number of rows to preview select a uuid or timestamp as the most efficient way to seperate a csv file the system will automatically combine any entires that have the same name into a single expiriment this function can also be used to seperate measurmenets by any logical combination contianed in the file project manager setup after connecting the syste to a data source(s), the next step is to create a project required to house the amics data set projects can be made by right clicking anywhere in the "project manager" subpanel of the data interface panel a project must be placed at the top level, and an unlimited number of projects can then be nested to build the required project structure as a quick start option, dragging and dropping any supported file into the project manager panel will auto populate a project structure any project tree data model creation once the experiment data from amics has been imported into the project management structure, amics reports requires a data model to display and use the columnated data correctly to create a new data model for amics data, reports only requires the user to double click an amics experiment to auto create the data model once the data model is made, the same data model canbe reused for all future amics experimental data note! in the example image above, the experiment data has a red "x" mark, indicating that it currently does not have a valid data model a data model must only be added to the experiment, specimen, split, or project to correct this this will apply the data model to all experimental data below where the data model has been added if the data does not already have a model associated with it tabulated data visualization once the previous steps have been completed, amics reports can display the tabulated data from amics as separate tables at this point, further data curation can be undertaken using the more advanced features of amics reports these features are explained in more detail in the later functions description section
