Docs: Verify RepyV2 tutorial steps, code, etc.

[aaaaalbert]

The RepyV2 tutorial should be checked for accuracy, completeness, and newcomer friendliness. This extends to whether the code examples shown are correct and conform to the Style Guidelines. (You would be astonished by the number of student/researcher Repy programs I've seen that include traces from the tutorial code!)

Other potential issues include

• Vessel IDs currently aren't IP addresses in V2, but always hex strings (regardless of the nodes' NAT/FW status).
• Using actual NATted nodes, and using the proper clearinghouse interfaces for this (which are WIP).

Feel free to add concerns, questions, ideas, progress, links to things to discuss.

[priyam3nidhi]

I have gone through the Repy V2 tutorial and examined the steps for it. The steps are clearly defined where I was able to follow the given instructions to clone the repositories and test them. There are a few parts of the document that can be edited:

I) When specifying file path under the heading "General Operations with examples," we can edit part 3 as follows:
*3. Set up Repy V2 *

1. cd repy_v2/scripts. When in the scripts folder, run python initialize.py This downloads all of Repy V2's dependencies into a folder called repy_v2/DEPENDENCIES.
2. Still from the scripts/ directory, run python build.py ~/testv2 (in case of other OS like Windows, run build.py to copy all dependencies to a dir you specify(just like ../testv2) and then cd ../testv2 using the path) to copy over everything Repy V2 needs to run into the testv2 directory you created previously.

II) We need to alter the example name to example.1.1.r2py within "General operations with examples" which would provide consistency with the examples provided:

At present: "4. To run any code in Repy V2 (e.g., example.r2py), launch Repy from its directory: cd ~/testv2 ; python repy.py restrictions.test example.r2py"

Suggested: "4. To run any code in Repy V2 (e.g., example.r2py), launch Repy from its directory: cd ~/testv2 ; python repy.py restrictions.test example.1.1.r2py"

III) I tested the instructions under "Executing programs remotely in VMs" and found the instructions user-friendly. There is an edit regarding the IP address being produced in the examples.

IV) As stated, vessel IDs are always hex strings. I tested this remotely in VM and I always got different hex strings instead of IP addresses. I would modify the examples listed, in Step 3, within the tutorial section "Executing programs remotely in VMs." An example would be:

john@ !> browse
Added targets: %1(7563041c6e00c8c7ada1a8149584fdc3d8c743fa:1224:v9), %2(8563041c6e00c8c7ada1a8149584fdc3d8c743fa:2888:v9)
Added group 'browsegood' with 2 targets
The command browse produced the output that shows resources(targets) you can control.

V) I have also tried running the examples listed at the bottom of the tutorial. An issue to look at is "example4.2.r2py" which doesn't go through and gives a Traceback stating the import line as a cause. The error lies in "dy_import_module_symbols("random")" and I modified it to include an additional add_dy_support(locals()) which didn't fix the issue.

I will be looking at the last part of the ticket this week in relation to the clearinghouse ("Using actual NATted nodes, and using the proper clearinghouse interfaces for this").

[aaaaalbert]

As discussed on Skype, please comment on your progress as it happens.