EvoNEST tutorial

Complete beginner's course

This is a complete step-by-step guide from installation to first data entry, designed for non-technical users.

Technical user? If you already know how to use Docker, and are a confident developer, see the Technical documentation.

Welcome to the EvoNEST tutorial! This comprehensive guide will walk you through installing, configuring, and using EvoNEST for research data management - no technical experience required.

What you'll learn

By the end of this tutorial, you will be able to:

• ✅ Install and run EvoNEST using Docker
• ✅ Configure EvoNEST for your laboratory's needs
• ✅ Create and manage biological samples
• ✅ Record trait measurements and experimental data
• ✅ Manage backups and protect your data
• ✅ Troubleshoot common issues

Who this guide is for

This guide is designed for:

• Researchers and lab technicians new to EvoNEST
• Users with minimal command-line experience
• Labs setting up EvoNEST for the first time

No coding required

You don't need programming experience for this guide. We'll guide you through every step with instructions and screenshots.

Time estimate

Total duration: Approximately 3-4 hours

Module	Topic	Duration
1	Preparation	20-30 min
2	Installation	30 min
3	First launch	20 min
4	Configuration	30 min
5	Data entry and management	45 min
6	Backup & Maintenance	30-45 min

Guide modules

Module 1: Preparation

Start here → Preparation guide

Get your computer ready for EvoNEST installation. Install required software (Docker Desktop) and verify system requirements.

What you'll do:

• Check system requirements
• Install Docker Desktop
• Download tutorial materials

---

Module 2: Installation

Installation guide →

Set up EvoNEST on your computer using Docker. This module walks through cloning the repository and starting the development environment.

What you'll do:

• Clone the EvoNEST repository
• Configure environment files
• Start EvoNEST with Docker

---

Module 3: First launch

First launch guide →

Launch EvoNEST for the first time, log in, and verify everything is working correctly.

What you'll do:

• Access the EvoNEST web interface
• Log in with default credentials
• Verify the installation
• Navigate the interface

---

Module 4: Configuration

Configuration guide →

Customize EvoNEST for your laboratory. Set up sample types, trait types, equipment, and lab-specific settings.

What you'll do:

• Configure sample and subsample types
• Define trait types with units
• Set up sample ID generation rules
• Configure lab information

---

Module 5: Data entry and management

Data entry guide →

Learn the core workflows for managing research data in EvoNEST through hands-on exercises.

What you'll do:

• Create biological samples
• Record trait measurements
• Manage experiments
• Upload files and images
• Use the data explorer

---

Module 6: Backup & Maintenance

Backup & Maintenance guide →

Learn how to protect your data with EvoNEST's automated backup system and perform maintenance tasks.

What you'll do:

• Understand the automated backup system
• Check backup status and logs
• Download backups to your computer
• Restore from backups
• Create manual backups
• Back up file storage

Production Only

This module applies to production deployments. The development environment does not include automated backups.

---

Troubleshooting

Troubleshooting guide →

Reference guide for common issues and solutions. Consult this when you encounter problems.

What's covered:

• Docker and container issues
• Database connection problems
• File upload errors
• Browser compatibility
• Getting help

---

Guide format

Each module follows this structure:

1. Learning objectives - What you'll accomplish
2. Prerequisites - What you need before starting
3. Step-by-step instructions - Detailed walkthrough with screenshots
4. Checkpoint - Verify you've completed the module successfully
5. Troubleshooting - Solutions to common issues

Prerequisites

Before starting the guide, ensure you have:

• A computer with:

  • Windows 10/11, macOS 10.15+, or Linux
  • 8GB+ RAM (16GB recommended)
  • 20GB+ free disk space
  • Administrator/sudo privileges

• Internet connection for:

  • Downloading Docker Desktop
  • Cloning the repository
  • Accessing documentation

• Basic computer skills:

  • Installing software
  • Opening a terminal/command prompt
  • Using a web browser

Important

Make sure you have administrator rights on your computer. You'll need them to install Docker Desktop.

Getting help

If you get stuck:

1. Check the troubleshooting module - Most common issues are covered there
2. Review the specific module's tips - Each section has inline troubleshooting
3. Ask for help - Contact the EvoNEST team or open an issue on GitHub
4. Consult the full documentation - User guide has comprehensive details

After completing the tutorial

Once you complete this tutorial, you'll have EvoNEST installed and know the basics of data entry.

Continue learning:

• User documentation - Complete guide to all EvoNEST features:
  • Advanced sample management
  • Data analysis and visualization
  • Data import and export
  • Collaboration and permissions
• FAQ - Frequently asked questions

Ready to begin?

Let's get started! Head to Module 1: Preparation to begin setting up your environment.