Merge pull request #9 from JuliaQX/change-pkg-name

Change package name to QXTools

Author: nmoran

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
         version:
           - '1.6'
         os:
-          - ubuntu-latest          
+          - ubuntu-latest
         arch:
           - x64
     steps:
@@ -52,12 +52,12 @@ jobs:
             Pkg.instantiate()
             Pkg.add("Documenter")
             Pkg.add("DataFrames")
-            Pkg.add("Latexify")'            
+            Pkg.add("Latexify")'
       - run: |
           julia --project -e '
             using Documenter: doctest
-            using QXSim
-            doctest(QXSim)'
+            using QXTools
+            doctest(QXTools)'
       - run: julia --project docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Project.toml

@@ -1,4 +1,4 @@
-name = "QXSim"
+name = "QXTools"
 uuid = "84f0eee1-10ae-40da-994b-b9d0e53829ae"
 authors = ["QuantEx team"]
 version = "0.1.7"

bin/prepare_rqc_simulation_files.jl

@@ -1,5 +1,5 @@
-using QXSim
-using QXSim.Circuits
+using QXTools
+using QXTools.Circuits
 using ArgParse
 using Logging
 

docs/arch.puml

@@ -1,14 +1,14 @@
 push!(LOAD_PATH, "../")
-using QXSim, Documenter
+using QXTools, Documenter
 
 makedocs(;
-    modules=[QXSim],
+    modules=[QXTools],
     authors="QuantEx team",
-    repo="https://github.com/JuliaQX/QXSim.jl/blob/{commit}{path}#L{line}",
-    sitename="QXSim.jl",
+    repo="https://github.com/JuliaQX/QXTools.jl/blob/{commit}{path}#L{line}",
+    sitename="QXTools.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://JuliaQX.github.io/QXSim.jl",
+        canonical="https://JuliaQX.github.io/QXTools.jl",
         assets=String[],
     ),
     pages=[
@@ -21,5 +21,5 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/JuliaQX/QXSim.jl",
+    repo="github.com/JuliaQX/QXTools.jl",
 )

docs/make.jl

@@ -2,20 +2,20 @@
 
 ## Installation
 
-QXSim is a Julia package and can be installed using Julia's inbuilt package manager from the Julia REPL using.
+QXTools is a Julia package and can be installed using Julia's inbuilt package manager from the Julia REPL using.
 
 ```
 import Pkg
-Pkg.add("QXSim")
+Pkg.add("QXTools")
 ```
 
 ## Example usage
 
-An example of how QXSim can be used to calculate a set of amplitudes for small GHZ preparation circuit looks like
+An example of how QXTools can be used to calculate a set of amplitudes for small GHZ preparation circuit looks like
 
 ```
-using QXSim
-using QXSim.Circuits
+using QXTools
+using QXTools.Circuits
 using QXTns
 using QXGraphDecompositions
 
@@ -29,18 +29,18 @@ tnc = convert_to_tnc(circ)
 plan = quickbb_contraction_plan(tnc)
 
 # Contract the network using this plan to find the given amplitude for different outputs
-@show QXSim.single_amplitude(tnc, plan, "000")
-@show QXSim.single_amplitude(tnc, plan, "111")
-@show QXSim.single_amplitude(tnc, plan, "100")
+@show QXTools.single_amplitude(tnc, plan, "000")
+@show QXTools.single_amplitude(tnc, plan, "111")
+@show QXTools.single_amplitude(tnc, plan, "100")
 ```
 
 This is only recommended for small test cases. For larger scale runs one can call the `generate_simulation_files`
 which will do the conversion to a network, find the contraction plan and create output files describing the required
 calculations. For example
 
 ```
-using QXSim
-using QXSim.Circuits
+using QXTools
+using QXTools.Circuits
 
 # Create ghz circuit
 circ = create_ghz_circuit(3)

docs/src/getting_started.md

@@ -1,23 +1,23 @@
 ```@meta
-CurrentModule = QXSim
+CurrentModule = QXTools
 ```
 
-# QXSim
+# QXTools
 
-QXSim is a Julia package for simulating quantum circuits using tensor network approaches and targets large distibuted memory clusters with hardware
+QXTools is a Julia package for simulating quantum circuits using tensor network approaches and targets large distibuted memory clusters with hardware
 accelerators. It was developed as part of the QuantEx project, one of the individual software projects of WP8 of [PRACE](https://prace-ri.eu/) 6IP.
 
-QXSim ties together a number of other Julia packages which are also part of the QuantEx project. These include QXZoo for
+QXTools ties together a number of other Julia packages which are also part of the QuantEx project. These include QXZoo for
 generating and manipulating quantum circuits, QXTns for representing and manipulating tensor networks,
 QXGraphDecompositions which implements a number of graph algorithms for finding good contraction plans and finally QXRun which is designed to run on large distributed
-clusters and carry out the computations using input files generated using QXSim.
+clusters and carry out the computations using input files generated using QXTools.
 
-The design and implementation of QXSim and related packages was inspired by many other frameworks and packages including ITensors, TensorOperations.jl, OMEinsum.jl, Yao.jl, TAL-SH and ExaTN.
+The design and implementation of QXTools and related packages was inspired by many other frameworks and packages including ITensors, TensorOperations.jl, OMEinsum.jl, Yao.jl, TAL-SH and ExaTN.
 
 ## Where to begin
 
-For getting QXSim installed and setup, see the [Getting Started](@ref) section which has instructions on how to install QXSim and some hello world examples.
-The "Tutorials" section contains some more indepth examples and the "Users Guide" has more details of the design and structure of QXSim.
+For getting QXTools installed and setup, see the [Getting Started](@ref) section which has instructions on how to install QXTools and some hello world examples.
+The "Tutorials" section contains some more indepth examples and the "Users Guide" has more details of the design and structure of QXTools.
 
 ```@contents
 Pages = ["users_guide.md"]

docs/src/index.md

@@ -1,6 +1,6 @@
 # User's Guide
 
-QXSim generates output files which provide a description of the computations and data
+QXTools generates output files which provide a description of the computations and data
 required to perform the simulation. There are three output files:
 
 - Parameter file: This YAML file provides informations on the sliced edges and dimensions as well
@@ -57,14 +57,14 @@ different processes/nodes with a reduction operation performed on the scalars re
 
 ## DSL Specification
 
-A Domain Specific Language (DSL) has been defined when enables better separation 
+A Domain Specific Language (DSL) has been defined when enables better separation
 of concerns between the components. This DSL describes a contraction over a tensor
 network to calculate observables of interest in the form of a sequence of instructions
 which act on individual tensors. This makes it possible to separate the development
 of the high performance distributed tensor network computation code from that of the
-higher level contraction planning, circuit and and network manipulation code. For QXSim
+higher level contraction planning, circuit and and network manipulation code. For QXTools
 DSL files the ".qx" suffix is used for "Tensor Language". We will first show a very
-simple example of a QXSim DSL file and then descibe in detail how each of the
+simple example of a QXTools DSL file and then descibe in detail how each of the
 instructions work.
 
 ### Example DSL file

docs/src/users_guide.md

@@ -1,4 +1,4 @@
-module QXSim
+module QXTools
 using Logging
 import QXZoo
 import DataStructures: OrderedDict

src/QXSim.jl renamed to src/QXTools.jl

@@ -7,7 +7,7 @@ export convert_to_tnc
 """
 _convert_to_tnc(circ::QXZoo.Circuit.Circ; kwargs...)
 
-Function to convert a QXZoo circuit to a QXSim tensor network circuit
+Function to convert a QXZoo circuit to a QXTools tensor network circuit
 """
 function _convert_to_tnc(circ::QXZoo.Circuit.Circ; kwargs...)
     tnc = TensorNetworkCircuit(circ.num_qubits)
@@ -27,7 +27,7 @@ convert_to_tnc(circ::QXZoo.Circuit.Circ;
                no_output::Bool=false,
                kwargs...)
 
-Function to convert a QXZoo circuit to a QXSim tensor network circuit
+Function to convert a QXZoo circuit to a QXTools tensor network circuit
 """
 function convert_to_tnc(circ::QXZoo.Circuit.Circ;
                         input::Union{String, Nothing}=nothing,