NxNxN Rubik Cube implementation
Project description
MagicCube: A NxNxN Rubik Cube implementation
A fast implementation of the Rubik Cube based in Python 3.x.
Makes it easy to create cubes of various sizes (2x2x2, 3x3x3, 4x4x4, 6x6x6, ...., 100x100x100).
Fast rotation speed when compared with other Python implementations, which makes it suitable for Rubik Cube simulations.
Includes:
 Simple solver for the 3x3x3 cube.
 Move optimizer which reduces the number of moves.
Installation
pip install magiccube
Usage
import magiccube
# 3x3x3 Cube
cube = magiccube.Cube(3,"YYYYYYYYYRRRRRRRRRGGGGGGGGGOOOOOOOOOBBBBBBBBBWWWWWWWWW")
print(cube)
# Rotate the cube
cube.rotate("R' L2 U D' F B'2 R' L")
# Solve the 3x3x3 cube
solver = BasicSolver(cube)
solver.solve()
# Complex moves 6x6x6 Cube
cube = magiccube.Cube(6)
cube.rotate("Lw") # L wide rotation
cube.rotate("Lw'") # L wide counterrotation
cube.rotate("Lw2") # 2x L wide rotation
cube.rotate("3L") # 3rd line L rotation
cube.rotate("3Lw") # 3rd line L wide rotation
cube.rotate("3Lw'2") # 2x 3rd line L wide counterrotation
Examples
See examples folder.
Supported Moves and Notation
Basic moves
Move  

L L'  Clockwise/Counterclockwise cube rotation of the LEFT face. 
R R'  Clockwise/Counterclockwise cube rotation of the RIGHT face. 
D D'  Clockwise/Counterclockwise cube rotation of the DOWN face. 
U U'  Clockwise/Counterclockwise cube rotation of the UP face. 
F F'  Clockwise/Counterclockwise cube rotation of the FRONT face. 
B B'  Clockwise/Counterclockwise cube rotation of the BACK face. 
Advanced Moves
Move  

X X'  Cube rotation on X axis. X is the axis that points from LEFT to the RIGHT face. 
Y Y'  Cube rotation on Y axis. Y is the axis that points from DOWN to the UP face. 
Z Z'  Cube rotation on Z axis. Z is the axis that points from BACK to the FRONT face. 
M M'  Rotation of the center layer on the X axis. 
E E'  Rotation of the center layer on the Y axis. 
S S'  Rotation of the center layer on the Z axis. 
Fw Fw'  Wide rotation of 2 layers. 
3Fw 3Fw'  Wide rotation of 3 layers. 
3F 3F'  Rotation of the 3rd layer. 
F2 F2'  2x rotation. 
Cube Coordinates
 Cube coordinates are expressed as a tuple of x,y,z.
 (0,0,0) is the piece on the LEFT,DOWN,BACK corner.
 In a 3x3x3, (2,2,2) is the piece on the RIGH,UP,FRONT corner.
Solver
The solver uses the beginner method to solve the cube
Move Optimizer
The move optimizer does the following optimizations:
 Eliminates redundant moves (ex: L L L L)
 Converts 3x moves to the inverse (ex: F F F > F')
 Eliminates cube rotations (ex: Y F > R)
Development
Install pyenv
curl https://pyenv.run  bash
Setup the environment using pyenv
pyenv virtualenv 3.11 cube3.11
pyenv local cube3.11
pip install r requirements.txt
direnv allow
Install commit hooks
precommit install
Project details
Release history Release notifications  RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
magiccube0.3.0.tar.gz
(19.4 kB
view hashes)
Built Distribution
magiccube0.3.0py3noneany.whl
(16.9 kB
view hashes)
Close
Hashes for magiccube0.3.0py3noneany.whl
Algorithm  Hash digest  

SHA256  a8da38cac53dff1667949c9a12485bebb9d62c01ae73db41eb7aba1bc1c8a00c 

MD5  128b882a6bac79ebde6b796396f5f48e 

BLAKE2b256  f78d354a7357e03fb9277401989b7866b8f05ae407319e7bc450b958f9187308 