Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 5.93 KB

README.md

File metadata and controls

93 lines (66 loc) · 5.93 KB
Raw

Suravi is a distribution of Lua 5.3 and Ravi

Suravi is a work-in-progress distribution of Lua 5.3 and Ravi.

Goals

  • This is not a comprehensive distribution / package manager for Lua such as LuaRocks, LuaDist, or LuaPlus.
  • The goal of this distribution is to create a small distro with carefully selected libraries, and ensure that the distro has been tested as a whole.
  • There will be separate binary downloads for Lua and Ravi 5.3.
  • Target platforms are Windows 10, Linux, and Mac OSX; 64-bit versions only.
  • The build system is CMake; and the aim is to keep each module as independent of other modules as possible; however some modules such as those from Torch have interdependencies.
  • Create unified documentation and user guides; the whole distro should feel like a single product.

Libraries

The following libraries have been shortlisted for inclusion:

Library Description Status
LPegLabel LPegLabel is a conservative extension of the LPeg library that provides an implementation of Parsing Expression Grammars (PEGs) with labeled failures. Included
LPeg LPeg is a new pattern-matching library for Lua, based on Parsing Expression Grammars. see LPegLabel
lua-cjson Lua CJSON is a fast JSON encoding/parsing module for Lua Included
LuaFileSystem LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution. Included
lua-protobuf Google protobuf support for Lua Included
LuaSocket LuaSocket is a Lua extension library that is composed by two parts: a C core that provides support for the TCP and UDP transport layers, and a set of Lua modules that add support for functionality commonly needed by applications that deal with the Internet Included
luv libuv bindings for Lua. libuv is a multi-platform C library that provides support for asynchronous I/O based on event loops. Included
Moses A Lua utility-belt library for functional programming Included
Penlight A set of pure Lua libraries focusing on input data handling (such as reading configuration files), functional programming (such as map, reduce, placeholder expressions,etc), and OS path management. Much of the functionality is inspired by the Python standard libraries Included
Paths This package provides portable functions and variables to manipulate the file system Included
Torch7 Torch is the main package in Torch7 where data structures for multi-dimensional tensors and mathematical operations over these are defined. Additionally, it provides many utilities for accessing files, serializing objects of arbitrary types and other useful utilities, including a Unit Testing framework Included
Torch7-Autograd Autograd automatically differentiates native Torch code Included
Torch-Cephes Provides and wraps the mathematical functions from the Cephes mathematical library, developed by Stephen L. Moshier Broken
Torch7-NN This package provides an easy and modular way to build and train simple or complex neural networks using Torch Included
Torch7-Optim This package contains a number of optimization routines for Torch Included

Downloads

See the Releases page for available downloads.

Installation

Lua Version and Build Info

The version of Lua supported by this distro is 5.3.5. The following changes were made to stock Lua:

  • The LuaJIT bit library is included
  • The LUA_COMPAT_FLOATSTRING flag is enabled
  • The Lua 5.1 and 5.2 compatibility flags are enabled
  • The 'defer' statement has been added.
  • The Lua parser has been enhanced to ignore Ravi type annotations.

On Linux or Mac OSX

In the build folder there are some scripts to help build and install Suravi.

Assuming we are installing under $HOME/Software/ravi then we can invoke:

cd Suravi
sh build/linux_build.sh $HOME/Software/ravi

Once build is complete, we can setup the environment as follows.

source $HOME/Software/ravi/bin/ravi-env.sh

Replace ravi with lua53 if you are using Lua.

Note that the installation paths are copied to following files in the distro:

  • bin/ravi-env.sh or bin/lua-env.sh
  • share/lua/5.3/torch/paths.lua

On Windows

  • Note: The latest build includes VC++ 2019 runtime distributable
  • Install under c:\Software\ravi or c:\Software\lua53
  • Set environment variables as follows:
c:\Software\ravi\bin\ravi-env.bat

Replace ravi with lua53 if you are using Lua.

Note that if you install at some other location then you need to change the paths in the following files in the distro:

  • bin\ravi-env.bat or bin\lua-env.bat
  • share\lua\5.3\torch\paths.lua

Docker support

Please checkout the Dockerfiles in the repo - they should be self explanatory.