New structure according to the palette categories (#96)

* New structure according to the palette categories

* Fix test imports

* Update npm files

Switch npm files listing from quantum/ to nodes/

* Update workflow paths

Switch quantum/ path to nodes/ path.

* Update CONTRIBUTING.md

Update paths from quantum/ to nodes/

Co-authored-by: Louis Lefevre <[email protected]>

Author: Theo-Reignier

.github/workflows/node.js.yml

@@ -4,12 +4,12 @@ on:
   push:
     branches: [ master ]
     paths:
-      - 'quantum/**'
+      - 'nodes/**'
       - 'test/**'
   pull_request:
     branches: [ master ]
     paths:
-      - 'quantum/**'
+      - 'nodes/**'
       - 'test/**'
 
 jobs:

CONTRIBUTING.md

@@ -20,7 +20,7 @@
   ],
   "files": [
     "bin/",
-    "quantum/",
+    "nodes/",
     "AUTHORS",
     "CHANGELOG.md"
   ],
@@ -52,30 +52,30 @@
   },
   "node-red": {
     "nodes": {
-      "quantum-circuit": "quantum/nodes/quantum-circuit/quantum-circuit.js",
-      "quantum-register": "quantum/nodes/quantum-register/quantum-register.js",
-      "classical-register": "quantum/nodes/classical-register/classical-register.js",
-      "qubit": "quantum/nodes/qubit/qubit.js",
-      "reset": "quantum/nodes/reset/reset.js",
-      "barrier": "quantum/nodes/barrier/barrier.js",
-      "swap": "quantum/nodes/swap/swap.js",
-      "identity-gate": "quantum/nodes/identity-gate/identity-gate.js",
-      "not-gate": "quantum/nodes/not-gate/not-gate.js",
-      "rotation-gate": "quantum/nodes/rotation-gate/rotation-gate.js",
-      "phase-gate": "quantum/nodes/phase-gate/phase-gate.js",
-      "unitary-gate": "quantum/nodes/unitary-gate/unitary-gate.js",
-      "hadamard-gate": "quantum/nodes/hadamard-gate/hadamard-gate.js",
-      "cnot-gate": "quantum/nodes/cnot-gate/cnot-gate.js",
-      "toffoli-gate": "quantum/nodes/toffoli-gate/toffoli-gate.js",
-      "controlled-u-gate": "quantum/nodes/controlled-u-gate/controlled-u-gate.js",
-      "multi-controlled-u-gate": "quantum/nodes/multi-controlled-u-gate/multi-controlled-u-gate.js",
-      "measure": "quantum/nodes/measure/measure.js",
-      "bloch-sphere": "quantum/nodes/bloch-sphere/bloch-sphere.js",
-      "circuit-diagram": "quantum/nodes/circuit-diagram/circuit-diagram.js",
-      "script": "quantum/nodes/script/script.js",
-      "local-simulator": "quantum/nodes/local-simulator/local-simulator.js",
-      "ibm-quantum-system": "quantum/nodes/ibm-quantum-system/ibm-quantum-system.js",
-      "grovers":  "quantum/nodes/grovers/grovers.js"
+      "quantum-circuit": "nodes/quantum/quantum-circuit/quantum-circuit.js",
+      "quantum-register": "nodes/quantum/quantum-register/quantum-register.js",
+      "classical-register": "nodes/quantum/classical-register/classical-register.js",
+      "qubit": "nodes/quantum/qubit/qubit.js",
+      "reset": "nodes/quantum/reset/reset.js",
+      "barrier": "nodes/quantum/barrier/barrier.js",
+      "swap": "nodes/quantum/swap/swap.js",
+      "identity-gate": "nodes/quantum/identity-gate/identity-gate.js",
+      "not-gate": "nodes/quantum/not-gate/not-gate.js",
+      "rotation-gate": "nodes/quantum/rotation-gate/rotation-gate.js",
+      "phase-gate": "nodes/quantum/phase-gate/phase-gate.js",
+      "unitary-gate": "nodes/quantum/unitary-gate/unitary-gate.js",
+      "hadamard-gate": "nodes/quantum/hadamard-gate/hadamard-gate.js",
+      "cnot-gate": "nodes/quantum/cnot-gate/cnot-gate.js",
+      "toffoli-gate": "nodes/quantum/toffoli-gate/toffoli-gate.js",
+      "controlled-u-gate": "nodes/quantum/controlled-u-gate/controlled-u-gate.js",
+      "multi-controlled-u-gate": "nodes/quantum/multi-controlled-u-gate/multi-controlled-u-gate.js",
+      "measure": "nodes/quantum/measure/measure.js",
+      "bloch-sphere": "nodes/quantum/bloch-sphere/bloch-sphere.js",
+      "circuit-diagram": "nodes/quantum/circuit-diagram/circuit-diagram.js",
+      "script": "nodes/quantum/script/script.js",
+      "local-simulator": "nodes/quantum/local-simulator/local-simulator.js",
+      "ibm-quantum-system": "nodes/quantum/ibm-quantum-system/ibm-quantum-system.js",
+      "grovers":  "nodes/quantum-algorithms/grovers/grovers.js"
     }
   }
 }

quantum/errors.js renamed to nodes/errors.js

@@ -1,29 +1,30 @@
 'use strict';
 
 const NODES = {
-  'barrier': require('../quantum/nodes/barrier/barrier.js'),
-  'bloch-sphere': require('../quantum/nodes/bloch-sphere/bloch-sphere.js'),
-  'circuit-diagram': require('../quantum/nodes/circuit-diagram/circuit-diagram.js'),
-  'classical-register': require('../quantum/nodes/classical-register/classical-register.js'),
-  'cnot-gate': require('../quantum/nodes/cnot-gate/cnot-gate.js'),
-  'controlled-u-gate': require('../quantum/nodes/controlled-u-gate/controlled-u-gate.js'),
-  'hadamard-gate': require('../quantum/nodes/hadamard-gate/hadamard-gate.js'),
-  'ibm-quantum-system': require('../quantum/nodes/ibm-quantum-system/ibm-quantum-system.js'),
-  'identity-gate': require('../quantum/nodes/identity-gate/identity-gate.js'),
-  'local-simulator': require('../quantum/nodes/local-simulator/local-simulator.js'),
-  'measure': require('../quantum/nodes/measure/measure.js'),
-  'multi-controlled-u-gate': require('../quantum/nodes/multi-controlled-u-gate/multi-controlled-u-gate.js'),
-  'not-gate': require('../quantum/nodes/not-gate/not-gate.js'),
-  'phase-gate': require('../quantum/nodes/phase-gate/phase-gate.js'),
-  'quantum-circuit': require('../quantum/nodes/quantum-circuit/quantum-circuit.js'),
-  'quantum-register': require('../quantum/nodes/quantum-register/quantum-register.js'),
-  'qubit': require('../quantum/nodes/qubit/qubit.js'),
-  'reset': require('../quantum/nodes/reset/reset.js'),
-  'rotation-gate': require('../quantum/nodes/rotation-gate/rotation-gate.js'),
-  'script': require('../quantum/nodes/script/script.js'),
-  'swap': require('../quantum/nodes/swap/swap.js'),
-  'toffoli-gate': require('../quantum/nodes/toffoli-gate/toffoli-gate.js'),
-  'unitary-gate': require('../quantum/nodes/unitary-gate/unitary-gate.js'),
+  'barrier': require('../nodes/quantum/barrier/barrier.js'),
+  'bloch-sphere': require('../nodes/quantum/bloch-sphere/bloch-sphere.js'),
+  'circuit-diagram': require('../nodes/quantum/circuit-diagram/circuit-diagram.js'),
+  'classical-register': require('../nodes/quantum/classical-register/classical-register.js'),
+  'cnot-gate': require('../nodes/quantum/cnot-gate/cnot-gate.js'),
+  'controlled-u-gate': require('../nodes/quantum/controlled-u-gate/controlled-u-gate.js'),
+  'grovers': require('../nodes/quantum-algorithms/grovers/grovers.js'),
+  'hadamard-gate': require('../nodes/quantum/hadamard-gate/hadamard-gate.js'),
+  'ibm-quantum-system': require('../nodes/quantum/ibm-quantum-system/ibm-quantum-system.js'),
+  'identity-gate': require('../nodes/quantum/identity-gate/identity-gate.js'),
+  'local-simulator': require('../nodes/quantum/local-simulator/local-simulator.js'),
+  'measure': require('../nodes/quantum/measure/measure.js'),
+  'multi-controlled-u-gate': require('../nodes/quantum/multi-controlled-u-gate/multi-controlled-u-gate.js'),
+  'not-gate': require('../nodes/quantum/not-gate/not-gate.js'),
+  'phase-gate': require('../nodes/quantum/phase-gate/phase-gate.js'),
+  'quantum-circuit': require('../nodes/quantum/quantum-circuit/quantum-circuit.js'),
+  'quantum-register': require('../nodes/quantum/quantum-register/quantum-register.js'),
+  'qubit': require('../nodes/quantum/qubit/qubit.js'),
+  'reset': require('../nodes/quantum/reset/reset.js'),
+  'rotation-gate': require('../nodes/quantum/rotation-gate/rotation-gate.js'),
+  'script': require('../nodes/quantum/script/script.js'),
+  'swap': require('../nodes/quantum/swap/swap.js'),
+  'toffoli-gate': require('../nodes/quantum/toffoli-gate/toffoli-gate.js'),
+  'unitary-gate': require('../nodes/quantum/unitary-gate/unitary-gate.js'),
 };
 
 class FlowBuilder {

quantum/python.js renamed to nodes/python.js

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const barrierNode = require('../../quantum/nodes/barrier/barrier.js');
-const snippets = require('../../quantum/snippets.js');
+const barrierNode = require('../../nodes/quantum/barrier/barrier.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('BarrierNode', function() {

quantum/nodes/grovers/grovers.html renamed to nodes/quantum-algorithms/grovers/grovers.html

@@ -1,8 +1,8 @@
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const blochSphereNode = require('../../quantum/nodes/bloch-sphere/bloch-sphere.js');
-const snippets = require('../../quantum/snippets.js');
+const blochSphereNode = require('../../nodes/quantum/bloch-sphere/bloch-sphere.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('BlochSphereNode', function() {

quantum/nodes/grovers/grovers.js renamed to nodes/quantum-algorithms/grovers/grovers.js

@@ -1,8 +1,8 @@
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const circuitDiagramNode = require('../../quantum/nodes/circuit-diagram/circuit-diagram.js');
-const snippets = require('../../quantum/snippets.js');
+const circuitDiagramNode = require('../../nodes/quantum/circuit-diagram/circuit-diagram.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('CircuitDiagramNode', function() {

quantum/nodes/grovers/locales/en-US/grovers.html renamed to nodes/quantum-algorithms/grovers/locales/en-US/grovers.html

@@ -1,9 +1,9 @@
 const util = require('util');
 const testUtil = require('../test-util');
-const classicalRegisterNode = require('../../quantum/nodes/classical-register/classical-register.js');
+const classicalRegisterNode = require('../../nodes/quantum/classical-register/classical-register.js');
 const {FlowBuilder} = require('../flow-builder');
 const nodeTestHelper = testUtil.nodeTestHelper;
-const snippets = require('../../quantum/snippets.js');
+const snippets = require('../../nodes/snippets.js');
 
 describe('ClassicalRegisterNode', function() {
   beforeEach(function(done) {

quantum/nodes/barrier/barrier.html renamed to nodes/quantum/barrier/barrier.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const cnotGateNode = require('../../quantum/nodes/cnot-gate/cnot-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const cnotGateNode = require('../../nodes/quantum/cnot-gate/cnot-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('CnotGateNode', function() {

quantum/nodes/barrier/barrier.js renamed to nodes/quantum/barrier/barrier.js

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const controlledUGateNode = require('../../quantum/nodes/controlled-u-gate/controlled-u-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const controlledUGateNode = require('../../nodes/quantum/controlled-u-gate/controlled-u-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('ControlledUGateNode', function() {

quantum/nodes/barrier/locales/en-US/barrier.html renamed to nodes/quantum/barrier/locales/en-US/barrier.html

@@ -1,4 +1,4 @@
-const groversNode = require('../../quantum/nodes/grovers/grovers.js');
+const groversNode = require('../../nodes/quantum-algorithms/grovers/grovers.js');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const assert = require('chai').assert;

quantum/nodes/bloch-sphere/bloch-sphere.html renamed to nodes/quantum/bloch-sphere/bloch-sphere.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const hadamardGateNode = require('../../quantum/nodes/hadamard-gate/hadamard-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const hadamardGateNode = require('../../nodes/quantum/hadamard-gate/hadamard-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('HadamardGateNode', function() {

quantum/nodes/bloch-sphere/bloch-sphere.js renamed to nodes/quantum/bloch-sphere/bloch-sphere.js

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const ibmQuantumSystemNode = require('../../quantum/nodes/ibm-quantum-system/ibm-quantum-system.js');
-const snippets = require('../../quantum/snippets.js');
+const ibmQuantumSystemNode = require('../../nodes/quantum/ibm-quantum-system/ibm-quantum-system.js');
+const snippets = require('../../nodes/snippets.js');
 
 // DO NOT COMMIT YOUR API TOKEN!
 const API_TOKEN = '';

quantum/nodes/bloch-sphere/locales/en-US/bloch-sphere.html renamed to nodes/quantum/bloch-sphere/locales/en-US/bloch-sphere.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const identityGateNode = require('../../quantum/nodes/identity-gate/identity-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const identityGateNode = require('../../nodes/quantum/identity-gate/identity-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('IdentityGateNode', function() {

quantum/nodes/circuit-diagram/circuit-diagram.html renamed to nodes/quantum/circuit-diagram/circuit-diagram.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const localSimulatorNode = require('../../quantum/nodes/local-simulator/local-simulator.js');
-const snippets = require('../../quantum/snippets.js');
+const localSimulatorNode = require('../../nodes/quantum/local-simulator/local-simulator.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('LocalSimulatorNode', function() {

quantum/nodes/circuit-diagram/circuit-diagram.js renamed to nodes/quantum/circuit-diagram/circuit-diagram.js

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const measureNode = require('../../quantum/nodes/measure/measure.js');
-const snippets = require('../../quantum/snippets.js');
+const measureNode = require('../../nodes/quantum/measure/measure.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('MeasureNode', function() {

quantum/nodes/circuit-diagram/locales/en-US/circuit-diagram.html renamed to nodes/quantum/circuit-diagram/locales/en-US/circuit-diagram.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const multiControlledUGateNode = require('../../quantum/nodes/multi-controlled-u-gate/multi-controlled-u-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const multiControlledUGateNode = require('../../nodes/quantum/multi-controlled-u-gate/multi-controlled-u-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('MultiControlledUGateNode', function() {

quantum/nodes/classical-register/classical-register.html renamed to nodes/quantum/classical-register/classical-register.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const notGateNode = require('../../quantum/nodes/not-gate/not-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const notGateNode = require('../../nodes/quantum/not-gate/not-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('NotGateNode', function() {

quantum/nodes/classical-register/classical-register.js renamed to nodes/quantum/classical-register/classical-register.js

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const phaseGateNode = require('../../quantum/nodes/phase-gate/phase-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const phaseGateNode = require('../../nodes/quantum/phase-gate/phase-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('PhaseGateNode', function() {

quantum/nodes/classical-register/locales/en-US/classical-register.html renamed to nodes/quantum/classical-register/locales/en-US/classical-register.html

@@ -1,9 +1,9 @@
 const util = require('util');
 const testUtil = require('../test-util');
-const quantumCircuitNode = require('../../quantum/nodes/quantum-circuit/quantum-circuit.js');
+const quantumCircuitNode = require('../../nodes/quantum/quantum-circuit/quantum-circuit.js');
 const {FlowBuilder} = require('../flow-builder');
 const nodeTestHelper = testUtil.nodeTestHelper;
-const snippets = require('../../quantum/snippets.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('QuantumCircuitNode', function() {

quantum/nodes/cnot-gate/cnot-gate.html renamed to nodes/quantum/cnot-gate/cnot-gate.html

@@ -1,9 +1,9 @@
 const util = require('util');
 const testUtil = require('../test-util');
-const quantumRegisterNode = require('../../quantum/nodes/quantum-register/quantum-register.js');
+const quantumRegisterNode = require('../../nodes/quantum/quantum-register/quantum-register.js');
 const {FlowBuilder} = require('../flow-builder');
 const nodeTestHelper = testUtil.nodeTestHelper;
-const snippets = require('../../quantum/snippets.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('QuantumRegisterNode', function() {

quantum/nodes/cnot-gate/cnot-gate.js renamed to nodes/quantum/cnot-gate/cnot-gate.js

@@ -1,4 +1,4 @@
-const qubitNode = require('../../quantum/nodes/qubit/qubit.js');
+const qubitNode = require('../../nodes/quantum/qubit/qubit.js');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 

quantum/nodes/cnot-gate/locales/en-US/cnot-gate.html renamed to nodes/quantum/cnot-gate/locales/en-US/cnot-gate.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const resetNode = require('../../quantum/nodes/reset/reset.js');
-const snippets = require('../../quantum/snippets.js');
+const resetNode = require('../../nodes/quantum/reset/reset.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('ResetNode', function() {

quantum/nodes/controlled-u-gate/controlled-u-gate.html renamed to nodes/quantum/controlled-u-gate/controlled-u-gate.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const rotationGateNode = require('../../quantum/nodes/rotation-gate/rotation-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const rotationGateNode = require('../../nodes/quantum/rotation-gate/rotation-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('RotationGateNode', function() {

quantum/nodes/controlled-u-gate/controlled-u-gate.js renamed to nodes/quantum/controlled-u-gate/controlled-u-gate.js

@@ -1,4 +1,4 @@
-const scriptNode = require('../../quantum/nodes/script/script.js');
+const scriptNode = require('../../nodes/quantum/script/script.js');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 

quantum/nodes/controlled-u-gate/locales/en-US/controlled-u-gate.html renamed to nodes/quantum/controlled-u-gate/locales/en-US/controlled-u-gate.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const swapNode = require('../../quantum/nodes/swap/swap.js');
-const snippets = require('../../quantum/snippets.js');
+const swapNode = require('../../nodes/quantum/swap/swap.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('SwapNode', function() {

quantum/nodes/hadamard-gate/hadamard-gate.html renamed to nodes/quantum/hadamard-gate/hadamard-gate.html

@@ -2,8 +2,8 @@ const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
-const toffoliGateNode = require('../../quantum/nodes/toffoli-gate/toffoli-gate.js');
-const snippets = require('../../quantum/snippets.js');
+const toffoliGateNode = require('../../nodes/quantum/toffoli-gate/toffoli-gate.js');
+const snippets = require('../../nodes/snippets.js');
 
 
 describe('ToffoliGateNode', function() {