Download

From Olympus
Jump to: navigation, search

Olympus is freely available for download. Of course, you have to figure out how to use it. To get started, please read the instructions on this page.

Contents

BSD-Based License

The complete RavenClaw/Olympus distribution falls under the following BSD-based free and open-source software license. Some parts of the distribution may fall under different copyright holders, but their licenses are in a similar class as this license.

Copyright (c) 1998-2015 Carnegie Mellon University. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

This work was supported in part by funding from the Defense Advanced Research Projects Agency and the National Science Foundation of the United States of America, and the CMU Sphinx Speech Consortium.

THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Prerequisites

You need the following software as part of your installation. As a rule you should install the most recent versions, irrespective of those indicated below (which should be considered as the minimum version required). Olympus is maintained relative to the most recent versions of these application, but sometimes we miss something that's changed. Please let us know if you encounter a compatibility problem.

Requirement Tested Version Recommend Versions
Operating System Microsoft Windows 7sp1 Windows 7
Source Control Subversion 1.8 TortoiseSVN 1.8 or newer
Build Manager Kitware's CMake 3.3.3 Kitware's CMake (most recent)
Perl 5 Perl 5.20
modules: Win32::{RunAsAdmin,TieRegistry,API,Env}
ActiveState
Strawberry
Python Python 2.7 Python 2.7
Java JDK 8u45 with NetBeans 8.0.2 (provides Java and ANT) NetBeans
C++ Visual Studio 12 Visual Studio Express
Text-To-Speech CMU Flite Flite or Cepstral's Swift

Downloading and Building Olympus

Before starting please read the licensing agreement and make sure that you and/or your organization agree (don't worry, this is open source code).

Then follow these steps:

  1. Download and install any prerequisites you might need, as per the table above.
  2. Checkout Olympus from the repository. (We show command-line versions; consider TortoiseSVN for GUI access.)
  3. Open a cmd in the top-level folder (likely to be Olympus) and cd to it.
    • > cd ...\Olympus
  4. Run the Build script OlympusBuild.bat. This will build the core Olympus agents and libraries. For a clean build, use OlympusRebuild.bat
    • > OlympusBuild.bat.
      • This also builds sphinxbase, pocketsphinx and flite, which support speech i/o.
      • The environment variable OLYMPUS_ROOT is set to the root of the build. (Your applications need this.) You may need to reboot.
  5. Check the build.log file. At the bottom it should indicate successful completion.

You now have the necessary infrastructure to build and run Olympus-based systems.

Building and Running an Application

The build process for an application is simple, and uses the same script as the system build.

  1. Download either the tutorials, which can be found on the Documentation page, or checkout an example system. Be sure to get a compatible version (e.g. 2.6/).
  2. Run SystemBuild.pl.
  3. Check the build.log file.

To start up an Olympus system:

  1. Run SystemRun.bat in the application's root.
  2. The dashboard should come up, and all modules should be green.
  3. Click "TTYRecognitionServer" and then type init_session into the input box.
    • The system should greet you by voice (well, assuming that you have a speaker and the level is set right).
    • You can then either type into the input box or speak into a connected microphone.
    • If you are using a microphone be sure that it is in fact connected and that the levels are reasonable. You can do this by first recording and playing back an utterance. Adjust the audio so that it's not too loud or too soft. If you hear significant noise or static, the system may not understand you; you should investigate and fix.

You now have a running Olympus system. And the fun begins.

Documentation

Main article: Documentation

The documentation page is under construction but contains or will contain soon a complete tutorial on how to build systems with Olympus, as well as a number of reference pages for different parts of the architecture and pages on advanced topics for experienced developers. See Documentation.

In the meantime, feel free to e-mail any questions to the developers mailing list (olympus-developers@cs.cmu.edu).

Questions and Problems

Some annoying problems you may encounter when starting out:

  1. Depending on details of your system configuration, you may need to build from an "administrator" cmd window. To get one, right-click on the cmd icon and select the "Run as administrator" option.
  2. If a build is interrupted, file handles may remain open and the next build attempt is likely to fail. This a Windows thing. To start clean close the cmd window and open a new one.
  3. Occasionally problems crop up that have to do with differences between 32bit and 64bit architectures. Olympus is configured to create 32bit binaries. However you might already have installed a 64bit version of a prerequisite application which may introduce incompatible binaries. Check whether reinstalling its 32bit version fixes things.
  4. Be careful if you have multiple Visual Studios installed on your machine. Although they are supposed to peacefully coexist, we've found that VS 10 will sometimes stop building correctly if you also have VS 11, 12, 13 on your machine.
  5. Note that while the system can build with earlier versions of VS (5, 8), these are no longer actively supported. Remember that Visual Studio Express is available for free and will correctly build Olympus. If possible, we recommend that you install it. Olympus support takes it into account.


For additional information, as well as answers to specific questions, e-mail the developers mailing list (olympus-developers@cs.cmu.edu). You may want to attach a (ZIPPED!) copy of your build.log file in the email. You should probably examine the log file first and see if you can figure out what's wrong on your own. There should a summary of errors at the bottom of the log, but also search for the word FAILED to get at the details.



Personal tools