• Tour
    • Basics
    • Test Engineers
    • Design Engineers
  • Guides
  • Videos
  • Publications
  • API
  • Github
  • Community
  • Release Notes
  • Plugins
Getting Started with Origen
  • Introduction
  • Core concepts
  • How to Install
  • How to Install (Windows)
  • Company Customization
  • Understanding Gems
  • Creating a New App
  • Invoking Considerations
  • The Initial Commit
  • Workspace Management
  • Application Architecture
Runtime Environment
  • Introduction
  • Mode
  • Environment
  • Target
  • Production Targets
  • Global Setup
  • Load Order
  • Programming
Models
  • Introduction
  • Naming
  • Definition & Hierarchy
  • Adding Attributes
  • Versioning
  • Bugs & Features
  • Package, Mode & Configuration
  • Registers
  • Pins
  • Power Domains
  • Hardware Attributes
  • Parameters
  • Specifications
  • Fuses
  • Generic Components
  • Creating Your Own Components
Compiler (Views)
  • Introduction
  • Creating Templates
  • Using Sub-Templates
  • Helpers
  • Running The Compiler
  • Inline Compiler
Controllers
  • Introduction
  • Shadow Controllers
  • Direct Controllers
Pattern Generator
  • Introduction
  • Creating Patterns
  • Pins
  • Timing and Waiting
  • Registers
  • Documenting Patterns
  • Generating by Name
  • Common API
  • J750 API
  • V93K API
  • UltraFlex API
  • Custom Testers
  • Running The PatGen
  • Concurrent Patterns
Test Program Generator
  • Introduction
  • Philosophy
  • Creating Flows
  • Managing Flow Control
  • Creating an Interface
  • Additional Resources
  • Dynamic Custom Code
  • J750 API
  • V93K API
  • UltraFLEX API
  • Documenting the Program
  • Creating Custom Testers
  • Running the ProgGen
Simulation
  • Introduction
  • How It Works
  • Compiling the DUT
  • Environment Setup
  • Application Setup
  • Simulating Patterns
  • Simulating Flows
  • Simulator Log Output
  • Artifacts
  • Debugging
Documentation Generator
  • Introduction
  • Markdown
  • Linking
  • Styling
  • Testing
  • API Generation
  • Deploying
Plugins
  • Introduction
  • Using a Plugin
  • Creating a Plugin
  • Current Plugin
  • Dev Environment
  • Dev Considerations
  • Paths & Origen.root
  • Config & Origen.app
  • Miscellaneous Topics
Miscellaneous
  • Revision Control
  • Origen Remotes
  • Lint Testing
  • Session Store
  • LSF API
  • Users, Emails & Maillists
  • Utilities & Helpers
  • Ruby Extensions
  • Logger
  • Adding Commands
  • Overriding Commands
  • Callbacks
  • Application Callbacks
Advanced Topics
  • Introduction
  • Invocation Customization
  • Custom App Generators

Getting Started with Origen

Introduction


Welcome to the Origen guides!

The Origen platform is written in Ruby and following this documentation will take you from a complete beginner to an Origen expert.

However, help is always at hand and if you have a question that is not covered by these guides, or if you find that something is unclear, then the best place to get help is to ask a question on Stack Overflow, using the origen-sdk tag.

This site is focussed specifically on the Origen API, but for background on Ruby the internet is your friend. Ruby is very popular for web development and as such it is extremely easy to Google for solutions to any Ruby-related problems that you may come across, or to find tutorials from which to learn.

The official Ruby website contains a quick tutorial on Ruby to get you started:

  • Ruby in 20 Minutes

Previous engineers who have learned Ruby have recommend the following resources:

  • Learn Ruby at rubymonk.com
  • Learn Ruby at codeacademy.com
  • Ruby for Newbies Video Tutorials
  • Ruby Koans

If you want to use regular expressions in your code the following website is invaluable:

  • Regular Expression Editor

Comments

Generated with the Origen Semiconductor Developer's Kit

Origen is released under the terms of the MIT license