[8c4ad8]: / docs / Local_Analyzer_Setup.md

Download this file

76 lines (57 with data), 2.2 kB

Local DNA Analyzer Setup Guide

This guide explains how to set up and run the local DNA Analyzer with web interface integration.

Prerequisites

  • Java 17 or higher
  • Gradle build tool
  • Modern web browser
  • DNA Analyzer application downloaded and built

Setup Steps

  1. Build the Application
    bash ./gradlew build

  2. Start the Local Server
    bash ./gradlew bootRun
    This will start the Spring Boot application on port 8080.

  3. Access the Web Interface

  4. Open your web browser and navigate to the DNAnalyzer website
  5. Scroll down to the "Local Analyzer" section
  6. You'll see a form with:
    • File path input field
    • Checkboxes for analysis features:
    • Verbose Mode (-v)
    • Detailed Report (-d)
    • Quick Analysis (-q)

Using the Local Analyzer

  1. Enter File Path
  2. Provide the full path to your DNA file
  3. Example: /path/to/your/dna/sequence.fa

  4. Select Features

  5. Check the boxes for desired analysis features
  6. Each feature maps to a command-line argument:

    • Verbose Mode → -v
    • Detailed Report → -d
    • Quick Analysis → -q
  7. Run Analysis

  8. Click the "Run Analysis" button
  9. The analysis will be performed locally using your installed DNA Analyzer
  10. Results will be displayed on the webpage

Troubleshooting

If you encounter issues:

  1. Server Connection
  2. Ensure the local server is running on port 8080
  3. Check if you see any error messages in the terminal

  4. File Access

  5. Verify the file path is correct and accessible
  6. Ensure proper read permissions for the file

  7. Analysis Errors

  8. Check the server logs for detailed error messages
  9. Verify that the DNA Analyzer is properly installed

Technical Details

  • The web interface communicates with a local REST API
  • API endpoint: http://localhost:8080/api/analyze
  • CORS is enabled to allow web access to local server
  • The server translates web interface selections into command-line arguments

For additional help or bug reports, please visit our GitHub repository or join our Discord server.