Skip to content

ODRAS - Ontology-Driven Requirements Analysis System - Transform complex documents into structured requirements in minutes, not months.

Notifications You must be signed in to change notification settings

laserpointlabs/ODRAS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ODRAS - Ontology-Driven Requirements Analysis System

Transform complex documents into structured requirements in minutes, not months.

ODRAS is an AI-powered platform that reads your project documents (like requirements specifications, technical manuals, and design documents) and automatically extracts, organizes, and structures requirements using intelligent analysis. Think of it as having an expert systems engineer who can instantly understand your documents and create a structured foundation for your project.

πŸ€” What is ODRAS?

The Problem: Traditional requirements analysis is slow and manual. Engineers spend weeks reading through hundreds of pages of documents, manually extracting requirements, and trying to organize them into a coherent system. This process is error-prone, time-consuming, and often results in missing or conflicting requirements.

The Solution: ODRAS uses AI to automatically:

  • πŸ“„ Read and understand your project documents
  • 🎯 Extract requirements using intelligent analysis
  • πŸ”— Organize and connect requirements logically
  • πŸ“Š Create visual models of your system
  • πŸ’¬ Answer questions about your requirements through an AI assistant

Real Example: Instead of spending weeks manually reading a 200-page requirements document, ODRAS can analyze it in minutes and give you a structured breakdown of all requirements, their relationships, and potential issues.

πŸš€ Key Features

πŸ€– AI Assistant (DAS)

  • Chat with your documents: Ask questions about your requirements in plain English
  • Voice interaction: Talk to the system using voice commands
  • Smart suggestions: Get recommendations based on your project context
  • Always learning: Remembers your project history and preferences

πŸ“‹ Requirements Workbench

  • Visual editor: Create and edit requirements using an intuitive interface
  • Smart organization: Automatically categorizes and links related requirements
  • Multiple views: Save different perspectives of your requirements
  • Import/Export: Works with standard formats (RDF, OWL, ReqIF)

πŸ“š Document Intelligence

  • Smart reading: AI understands complex technical documents
  • Automatic extraction: Finds requirements you might have missed
  • Knowledge management: Builds a searchable knowledge base
  • Workflow automation: Processes documents through defined workflows

πŸ‘₯ Project Management

  • Multiple projects: Organize different projects in one place
  • Team collaboration: Work together on requirements
  • User permissions: Control who can access what
  • Version control: Track changes and maintain history

πŸ› οΈ What Powers ODRAS

For the Technical Curious:

  • AI Engine: Uses advanced language models (OpenAI GPT) to understand documents
  • Database: Stores your requirements and knowledge in specialized databases
  • Web Interface: Modern web-based interface that works in any browser
  • Workflow Engine: Automates document processing using business process management
  • Container Technology: Runs everything in Docker containers for easy setup

Don't worry about the technical details - ODRAS handles all the complexity for you!

πŸš€ Quick Start (5 Minutes)

What You'll Need

  • Docker Desktop (download from docker.com if you don't have it)
  • Git (download from git-scm.com if you don't have it)
  • 5-10 minutes of your time

Step-by-Step Installation

Step 1: Download ODRAS

git clone https://github.com/laserpointlabs/ODRAS.git
cd ODRAS

Step 2: Install Everything (One Command)

chmod +x install.sh
./install.sh

This will download and set up all the necessary components automatically.

Step 3: Start ODRAS

./odras.sh start

This starts all the services. Wait about 30-60 seconds for everything to initialize.

Step 4: Open ODRAS in Your Browser

πŸŽ‰ You're Ready! ODRAS is now running and you can start analyzing documents.

First Steps After Installation

  1. Upload a document using the Document Management section
  2. Ask the AI assistant questions about your project
  3. Explore the Requirements Workbench to see how requirements are organized
  4. Try the voice features if you have a microphone

Need Help?

πŸ†˜ Troubleshooting

Common Issues and Solutions

❌ "Docker not found" error

  • Solution: Install Docker Desktop from docker.com and restart your computer

❌ "Port already in use" error

  • Solution: Stop other applications using port 8000, or run: ./odras.sh stop then ./odras.sh start

❌ "Permission denied" when running scripts

  • Solution: Run: chmod +x *.sh to make scripts executable

❌ ODRAS won't start or keeps crashing

  • Solution: Run: ./odras.sh clean -y then ./odras.sh init-db to reset everything

❌ Can't access the web interface

  • Solution: Make sure you're going to http://localhost:8000 (not https) and wait 60 seconds after starting

❌ Login doesn't work

  • Solution: Try these credentials:
    • Username: admin Password: admin
    • Username: das_service Password: das_service_2024!

❌ Still having problems?

  • Check the logs: ./odras.sh logs
  • Open an issue on GitHub with your error message

πŸ“š Learn More

For Beginners

For Advanced Users

Key Documents

πŸ‘¨β€πŸ’» For Developers

Want to Contribute or Customize ODRAS?

Prerequisites for Development:

  • Python 3.8+ installed on your computer
  • Docker and Docker Compose
  • Git

Setting Up for Development:

  1. Install Python dependencies

    pip install -r requirements.txt
  2. Start the database services

    ./odras.sh start-services
  3. Run ODRAS in development mode

    python -m backend.main

Running Tests:

# Test everything
pytest

# Test specific parts
pytest tests/api/          # API tests
pytest tests/unit/         # Unit tests
pytest tests/integration/  # Integration tests

Need Help with Development?

πŸ“ What's Inside ODRAS

For the Curious - Here's How ODRAS is Organized:

ODRAS/
β”œβ”€β”€ πŸ–₯️  backend/           # The "brain" - AI processing and APIs
β”œβ”€β”€ 🌐  frontend/          # The "face" - what you see in your browser
β”œβ”€β”€ πŸ“š  docs/              # All the documentation and guides
β”œβ”€β”€ πŸ”§  scripts/           # Helper tools and utilities
β”œβ”€β”€ πŸ§ͺ  tests/             # Quality assurance and testing
└── πŸ“Š  data/              # Sample files and configurations

You don't need to understand this structure to use ODRAS - it's just here for developers and the technically curious!

🀝 Want to Help?

We'd love your contribution! Whether you're a developer, designer, or just someone with ideas:

  1. Found a bug? Report it here
  2. Have an idea? Share it in discussions
  3. Want to code? Check out our Contributing Guide
  4. Want to help others? Answer questions in our discussions

πŸ“„ Legal Stuff

This project is open source under the MIT License. You can use it, modify it, and share it freely.

πŸ†˜ Get Help

Having trouble? We're here to help!

πŸš€ What's Coming Next

Exciting features in development:

  • πŸ“± Mobile app for on-the-go requirements analysis
  • πŸ”Œ Plugin system for custom integrations
  • 🎨 Enhanced visual tools and diagrams
  • πŸ€– Even smarter AI capabilities
  • πŸ“Š Advanced analytics and reporting

🎯 Ready to Get Started?

You're just 5 minutes away from transforming how you handle requirements!

  1. ⬇️ Download ODRAS
  2. πŸš€ Start analyzing documents
  3. πŸ’¬ Ask the AI assistant anything
  4. πŸ“ˆ See your productivity soar

ODRAS - Where complex documents become clear requirements in minutes, not months.

About

ODRAS - Ontology-Driven Requirements Analysis System - Transform complex documents into structured requirements in minutes, not months.

Resources

Stars

Watchers

Forks

Packages

No packages published