-
The EPI2ME Agent is a cross-platform desktop application for executing data analyses within the EPI2ME platform.
The EPI2ME Agent communicates with the EPI2ME platform API over secure https both to execute analyses and to transfer data files in and out. The Agent is configured using a user's credentials for the platform to enforce security access controls. The Agent also has rudimentary capabilities for filtering returned files post-analysis.
-
The Agent is also available as a command-line-only option.
The CLI Agent can be downloaded from https://epi2me.nanoporetech.com/software
-
Desktop Agent homepage
When installing the EPI2ME Agent for the first time, a registration must be entered on the home page. The registration code is obtained from the EPI2ME website and is needed to validate the user.
Once the code has been entered successfully, the New analysis tab becomes clickable and an analysis can be started.
-
Settings
The Settings page shows the profile that is currently in use, and information about the data input/output folders, network, and the version of the Agent.
-
Analysis
The appropriate analysis for the experiment can be chosen and run from the Analysis list.
-
Analysis parameters
In this section, the user can configure the analysis parameters.
-
Running an analysis
Once the initialisation is complete, the Agent will begin securely uploading sequence data into the EPI2ME portal. The analysis begins as soon as the first batch of sequence data is successfully uploaded. A subset of the analysis report can be viewed either in the Agent itself, or the full report can be viewed by clicking the View report button (enabled only when reports are available), which directs the user to the EPI2ME portal.
If data is uploaded in batches, the report will be updated periodically to enable users to monitor the progress of the analysis in real-time.
The analysis can be stopped at any time with the Stop upload button to only stop file upload, or Stop analysis to stop both file upload and analysis.
The Upload/download progress section will display the amount of already-uploaded data and number of files and reads that have been uploaded.
Once a report becomes available, it is shown as a summary in the Agent. A more detailed report is available from the EPI2ME portal.
The report in the Agent also links to the Output directory, Analysis workflow documentation page, and the Input directory.
-
Bug reports
If there is any problem with the EPI2ME Agent or data analysis, you can click the bug icon (shown in the red box) on the interface to send a report.
Alternatively, navigate to Report a bug in the EPI2MEAgent application menu. You can also access the log files from here.