elliottkobelansky / dlin

Python script to convert a 3BLD scramble into JSON describing cycles on the cube.

dlin

Describe piece cycles on a Rubik's Cube.

Installing

To install, run

pip install dlin

Usage: As a Python Package

The dlin.trace function converts a scramble (set of moves defined by WCA regulation 12a separated by spaces) into a python dictionary describing cycles on the cube.

To use, run

from dlin import trace

The following is example code to get the tracing for a scramble.

described_cycles = trace("F' L2 B2 F2 D' F2 D F2 U R2 U' L' B L' R' F2 R2 B2 U2 Fw'")

Here is an example of what could be contained in described_cycles

{
    "edge": [
        {
            "type": "cycle",
            "buffer": "UF",
            "targets": ["LD", "LF", "RU", "LU"],
            "orientation": 0,
            "parity": 0,
        },
        {
            "type": "cycle",
            "buffer": "UB",
            "targets": ["RB", "DR"],
            "orientation": 1,
            "parity": 0,
        },
        {
            "type": "cycle",
            "buffer": "FR",
            "targets": ["DB", "DF"],
            "orientation": 1,
            "parity": 0,
        },
    ],
    "corner": [
        {
            "type": "cycle",
            "buffer": "UFR",
            "targets": ["UBL", "RUB", "RDB", "FDR", "UFL", "FDL"],
            "orientation": 1,
            "parity": 0,
        },
        {
            "type": "misoriented",
            "buffer": "DBL",
            "targets": [],
            "orientation": -1,
            "parity": 0,
        },
    ],
    "scramble": "F' L2 B2 F2 D' F2 D F2 U R2 U' L' B L' R' F2 R2 B2 U2 Fw'",
    "rotation": ["z"],
}

Usage: Command Line Script

Run

dlin-trace [scramble]

Make sure to surround the scramble in quotation marks. This will output a json, with similar structure to the dictionary shown above.

dlin's Issues

README.md specifies incorrect usage for trace (maybe just a typo)

I was testing out the module and tried to have it trace a scramble. However, when I tried it out with the recommended usage with
"from dlin import tracer" and "described_cycles = tracer("F' L2 B2 F2 D' F2 D F2 U R2 U' L' B L' R' F2 R2 B2 U2 Fw'")" this was the result:
"Traceback (most recent call last): File "", line 1, in TypeError: 'module' object is not callable."

So, I think that "tracer" is a module and not a function, so it is not callable. I did find however that the function "trace" which was instantiated in dlin/init.py and is assumedly the intended object to call.
I think then that this is what you meant instead:
from dlin import trace
described_cycles = trace("F' L2 B2 F2 D' F2 D F2 U R2 U' L' B L' R' F2 R2 B2 U2 Fw'")

Unless semantically speaking you like the name "tracer" better but this is how I got it to work.
Also, calling "dlin-trace [scramble]" works fine for me