Getting Started with Origen
How to Install (Windows)
Origen can be installed on Linux or Windows, this guide refers to the Windows installation.
If you want to run on Linux then please see this guide instead: How to Install Origen on Linux
The vast majority of Origen use in production is on Linux, and over time this Windows guide can become out of date and no one realizes. If you do experience any issues when following this guide, then please do let us know via the comments below and we will update it as required.
Download Console by following this link.
Move the .zip file to C:/Program Files, then right click it and select Extract All....
Open the unzipped folder and right click on Console.exe and select Send to > Desktop (create shortcut).
Open the console from your desktop and execute the following command, we recommend that you create all of
your Origen application workspaces in C:\origen:
mkdir C:\origen
Select Edit > Settings from the console menu and enable the checkbox at the bottom
of the settings called Save settings to user directory.
Execute the following command to get a sensible set settings to start off with:
@powershell New-Item -ItemType directory -Force -Path %appdata%\Console; (new-object System.Net.WebClient).DownloadFile('https://origen-sdk.org/files/console.xml','%appdata%\Console\console.xml')
The rest of this guide requires you to open the console with administrator privileges and then execute the given commands, do this by right-clicking on the desktop shortcut you just created and selecting
Run as administrator.
Some of the operations will require that you open a new console session in order for the previous operation to take effect. If any errors are encountered please start a new console session and try again before reporting it.
Before starting this next section you should ensure that the following environment variables are set if your computer accesses the internet via a proxy (the proxy url here is an example and the real one will be specific to your company environment):
HTTP_PROXY = https://proxy.my_company.com:8080 HTTPS_PROXY = https://proxy.my_company.com:8080
Here is a link to a 3rd party tutorial on How to Create an Environment Variable in Windows.
The next step is to install a package manager, please copy the text below into the console (running as administrator)
@powershell -NoProfile -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
Install some required packages by running these commands from the console:
choco install git -y --force choco install unxutils -y --force choco install consoleZ -y --force
choco install ruby -y --version=2.3 --force choco install ruby2.devkit -y --force
Execute the following command from the console:
@powershell (new-object System.Net.WebClient).DownloadFile('https://rubygems.org/downloads/rubygems-update-2.7.3.gem’,'C:\rubygems-update-2.7.3.gem') && gem install --local C:\rubygems-update-2.7.3.gem && update_rubygems --no-ri --no-rdoc && gem uninstall rubygems-update -x
The conclusion of this alert box is don't stress too much about the exact versions you're using and if you run into issues installing gems, consider possible incompatabilities between the versions of Ruby, RubyGems, or the gem that you are trying to install. You can also use RubyGems to manually install the gems yourself, to bypass any installation options Origen may try to set.
Open C:\tools\DevKit2\config.yml in your favorite editor and write this at the
bottom:
- C:/tools/ruby23
Save it, and then execute the following commands from the console:
cd C:\tools\DevKit2\ ruby dk.rb install
Ensure that you see the following output when running the above command, if not review
what you have added to C:\tools\DevKit2\config.yml:
[INFO] Installing 'C:/tools/ruby22/lib/ruby/site_ruby/2.2.0/rubygems/default [INFO] Installing 'C:/tools/ruby22/lib/ruby/site_ruby/devkit.rb'
Finally, run this command to install Origen:
gem install origen --no-ri --no-rdoc
This can take several minutes to finish without updating the screen, so please be patient.
You can then verify Origen availability by running origen -v
at which point you should see something like this:
Origen: 0.44.0
Congratulations, Origen is now installed!
Some users have reported an error at this point which complains about the HOME
environment variable not being set.
If you see that, set it to something like this by following this 3rd party tutorial on How to Create an Environment Variable in Windows:
HOME = C:\Users\my_user_id
Note that the version of Origen that is installed to your Ruby installation does not need to be kept up to date with the latest version of Origen. You can now consider your Ruby environment to be frozen for the foreseeable future.
See the section on Understanding Gems for details on why that is.