Mercurial > pysmcl
changeset 228:100d45949680
README: some description of how to run the code.
author | Sigurd Meldgaard <stm@daimi.au.dk> |
---|---|
date | Wed, 23 Dec 2009 14:45:44 +0100 |
parents | 3b167513ce75 |
children | 4a5daaf345ab |
files | README |
diffstat | 1 files changed, 24 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/README Wed Dec 23 14:44:46 2009 +0100 +++ b/README Wed Dec 23 14:45:44 2009 +0100 @@ -1,17 +1,33 @@ +Requirements: + +To run a pysmcl application you will need a working install of +Viff (http://viff.dk), and that again requires a working Twisted, GMP, + This project uses the Python module ast, and therefore requires at least Python 2.6 +To run: + +To use the pysmcl runner, put your pysmcl base directory into your +PYTHONPATH environment variable. And run: + +python -m pysmcl.runpysmcl app.py player.ini + +Where app.py is a file containing the pysmcl script, and player.ini +contains the viff configuration of you want to use. + + A quick overview of the structure and files -pysmcl: Contains the source code of the PySmcl language. - compatibility_check.py: Checks if @secret functions use features outside their scope - flow.py: Builds a flow graph, and does fixpoint analysis on it - graph.py: Abstract datatype for a flowgraph, contains a todot method - util.py: Error-handling - pretty_print.py: Functions for pretty-printing the python AST-nodes +pysmcl: Contains the source code of the implementation of the PySmcl + language. compatibility_check.py: Checks if @secret functions use + features outside their scope flow.py: Builds a flow graph, and does + fixpoint analysis on it graph.py: Abstract datatype for a flowgraph, + contains a todot method util.py: Error-handling pretty_print.py: + Functions for pretty-printing the python AST-nodes secret_annotator.py: Analyses secret variables/expressions - proof_burden.py: Still only Proof of concept, prints out a proof-burden for openings - secret_ifs.py: Rewrites secret annotations + proof_burden.py: Still only Proof of concept, prints out a + proof-burden for openings secret_ifs.py: Rewrites secret annotations ideal_functionality.py: The decorator is declared here pysmcl/test: Various kinds of tests.