| 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: 2008/10/05 18:41:31 GMT+0 |
||
| Note: | ||
changed: - CALUA: CARA's scripting language CARA supports the Lua scripting language (see "Why Lua?":WhyLua). 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":http://www.lua.org Please refer to the <a href="CaLuaManual-0.5x.pdf">**CARA/Lua Programmers Manual**</a> (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 are not documented in the manual. Please consult the <a href="http://www.cara.nmr-software.org/downloads/Releasenotes/cara_release_history.htm">release notes</a> for brief descriptions of these new features. 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":StepByStepForCALUA 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. The scripts are organized into catagories according to what they do: - "All scripts":AllCaluaScripts is a page containing all scripts organized by type. This is useful to search for a script if you are not sure which catagory it belongs in. Use Browser function to search for keywords that might appear in the description of the script. - "Plot Data":ScriptsToPlotData collects scripts which generate plots from data derived from projects. - Export Data to a File: - "Analysis Reports":ScriptsToGenerateReports includes scripts that analyse data from projects. - "Export File for a Program":ScriptsToExportFileToProgram are all scripts that generate files readable by specific external programs like ATNOS/CANDID, CYANA, MOLMOL, PACES, XEASY, XPLOR. - "Write out spectral data":ScriptsToWriteOutSpectralData are scripts that write out spectral data into external files facilitating plotting with external programs. - "Convert External Files":ScriptsToConvertExternalFiles are scripts that convert external files into suitable format for reading in with CARA. - "Modify Projects":ScriptsToModifyProjects is the biggest collection of scripts. They are used to modify objects in a project such as Spins, Systems, !SpinLinks etc. - modify Aliases - modify Residues - modify !ResidueTypes - modify Peaks - modify Spins - modify !SpinLinks - "Other":ScriptToDoOtherThings is a place to collect scripts that don't fall into any of the above catagories. Most recently updated or new scripts: - "RemoveAliases.lua":ScriptsToModifyProjects 5.10.2008 **UPDATED** - "CalcMassOfLabeledMolecule.lua":ScriptsToGenerateReports 27.6.2008 **UPDATED** - "Pick_3D_Peaks.lua":ScriptsToModifyProjects 14.4.2008 **UPDATED** - "DefineInfo.lua":ScriptToDoOtherThings 8.2.2008 **NEW** - "WriteAssignments.lua":ScriptsToExportFileToProgram 8.2.2008 **UPDATED** - "ChangePeakColorCodes.lua":ScriptsToModifyProjects 1.2.2008 **NEW** ----------------------------------------------------------------------------- BACK: ReferenceValues NEXT: "Frequently asked questions":FAQ "Tutorials Page":Tutorials
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 are not documented in the manual. Please consult the release notes for brief descriptions of these new features. See below for some example scripts.
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
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.
-----------------------------------------------------------------------------
BACK: ReferenceValues?