https://github.com/opal-project/opalalgorithms

Algorithms for OPAL Project.
https://github.com/opal-project/opalalgorithms

algorithm opal python

Last synced: about 1 month ago
JSON representation

Algorithms for OPAL Project.

• Host: GitHub
• URL: https://github.com/opal-project/opalalgorithms
• Owner: OPAL-Project
• License: mit
• Created: 2018-01-11T10:09:17.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T02:23:06.000Z (11 months ago)
• Last Synced: 2024-10-07T23:25:42.019Z (about 1 month ago)
• Topics: algorithm, opal, python
• Language: Python
• Size: 85 KB
• Stars: 9
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# OPAL Algorithms

[![Build Status](https://travis-ci.org/OPAL-Project/opalalgorithms.svg?branch=master)](https://travis-ci.org/OPAL-Project/opalalgorithms)

Algorithms for OPAL Project. This repo contains python library of algorithms being used in OPAL Project. To implement any new algorithm, install this library, create a new class by inheriting the base class. Implement `map` function which takes `bandicoot` user and `params` for the algorithm.

Each algorithm runs in a sandboxed environment. We use [codejail](https://github.com/edx/codejail) for sandboxing. Codejail uses [apparmor](https://wiki.ubuntu.com/AppArmor) to ensure a proper sandboxed environment.

## Installation

Before you setup the library, it is very important you setup the codejail environment. Instructions for setting up can be found [here](https://github.com/edx/codejail). You will have to setup some environmental variables before setup.

```bash

export OPALALGO_SANDBOX_VENV=/path/to/sandbox/environment

export OPALALGO_SANDBOX_USER=sandbox-user

```

OPALAlgorithms works both in python 2.7 and python 3.6 environments. Before proceeding it is strictly recommended you activate virtualenv of python 2.7 or python 3.6 .To install follow the following steps:

```bash

git clone https://github.com/shubhamjain0594/opalalgorithms.git

cd opalalgorithms

pip install -r requirements.txt

python setup.py install

```

To run tests

```bash

cd tests

bash test.sh

```

## Usage Instructions

This library is to be used for writing new algorithms to be run on OPAL Platform. To write any new algorithm, you will have to inherit `opal.core.OPALAlgorithm` and implement `map` function. Ensure that you do not import any functions from external file and all the helper functions are available in the single file containing Algorithm class.

`map` function will get `params` which are the parameters of the request and [`bandicoot_user`](http://bandicoot.mit.edu/docs/reference/generated/bandicoot.User.html#bandicoot.User)

Also do ensure that you do not install any packages, except the ones installed by the opalalgorithm package.

A sample algorithm implementation for finding population density can be found at `tests/sample_algos/algo1.py`.

Use `tests/generate_data.py` for generating synthetic data for testing. Take a look at `tests/test.sh` and `tests/test_algos.py` to check how to test your algorithm implementation.

## Documentation

Please find hosted documentation [here](http://opalalgorithms.readthedocs.io/en/latest/index.html).

## TODO

- Codejail setup for memory and other restrictions

## Notes