Edit detail for CALUA revision 26 of 26

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
Editor: damberger
Time: 2017/10/03 09:38:15 GMT+2
Note: added update of ReadCyanaPeakList.lua

added:
  - <a href="AllCaluaScripts#MarkScriptsToModifyProjects">!ReadCyanaPeakList.lua</a> Oct. 3, 2017 ** UPDATED **


CALUA: CARA's scripting language

CARA supports the Lua scripting language (see Why Lua?). Lua is one of the fastest scripting languages available. The complete object model of CARA is accessible. Please note that the Lua standard libraries are also available, so you can do maths or read/write files. Lua scripts allow you to perform complicated manipulation of the data in the repository. You can make analyses of projects, export data for interaction with other programs, and create new graphic displays of the data. (See below for user scripts which support CARA with many useful functions).

General Lua Documentation is available at www.lua.org

Please refer to the CARA/Lua Programmers Manual (PDF, 500 KB, 100 pages) for how to program in LUA. The introductory section describes the basics with examples so that you quickly learn to write your own scripts. Newer features of CALUA included with beta releases are not documented in the manual. Please consult the CARA Forum for information regarding such changes. See below for some example scripts.

Importing CALUA scripts into CARA and running them:

Summary:

Select the Terminal Window in the CARA explorer, Click in the middle pane and Right-Click Import. Open the Script, Read the Header, Edit the user-define variables if the Header states that the user should do this. Back-up your Repository, and Execute the script.

Step-by-Step guide to loading and executing LUA scripts

User Scripts

These Scripts have been provided by CARA users for other CARA users "as is" with no guarantees. Always back-up your repository before running a script. Some of them may require some editing of the script to apply them to your project. After Importing the LUA script, Open it and read the header.

All scripts is a page containing all user scripts organized by type. You will find a hyperlinked index at the top and you can also search for keywords in the page to locate scripts of interest.

Most recently updated or new scripts:

-----------------------------------------------------------------------------

BACK: ReferenceValues

NEXT: Frequently asked questions

Tutorials Page