https://github.com/slowy07/clara
quantum computing package
https://github.com/slowy07/clara
Last synced: 3 months ago
JSON representation
quantum computing package
- Host: GitHub
- URL: https://github.com/slowy07/clara
- Owner: slowy07
- License: mit
- Created: 2023-06-26T00:59:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T01:57:24.000Z (11 months ago)
- Last Synced: 2025-03-18T06:23:09.289Z (3 months ago)
- Language: C++
- Homepage:
- Size: 1 MB
- Stars: 19
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Quantum computing is a type of computing that harnesses the power of quantum mechanics to solve problems that are too difficult for classical computers. Quantum computers use qubits, which are quantum bits, to store information. Qubits can be in a superposition of states, which means that they can be both 0 and 1 at the same time. This allows quantum computers to perform calculations that are exponentially faster than classical computers.
Clara are open sourec library for quantum computing processing that is designed to be faster on classical computer. the library provides a high-level interface for writing quantum algorithm and it uses a variety of techniques to optimize the performance of these algorithm on classical computer. the lib has the potential to make quantum algorithm more accessible to a wider range of researcher and developers and could help to accelerate the develompent of quantum computing applications
## Package used on clara
### Eigen
Eigen is a high-performance C++ template library for linear algebra. It provides a wide range of features, including matrices, vectors, numerical solvers, and related algorithms. Eigen is designed to be fast, efficient, and flexible. It is used by a wide range of developers, including those working in the fields of computer graphics, machine learning, and scientific computing.
website : [eigen.tuxfamily.org](https://eigen.tuxfamily.org/index.php?title=Main_Page)
repository: [gitlab](https://gitlab.com/libeigen/eigen)
*installation for clara*
- debian package (apt)
for installing lib eigen on ubuntu
```
sudo apt-get update
sudo apt-get install libeigen3-dev
cp -r /usr/local/include/eigen3/Eigen /usr/local/include
```
- arch package
for installing on arch based
```
yay -S eigen
```
information about package on arch : [here](https://archlinux.org/packages/extra/any/eigen/)
- MacOS
for installing on MacOS based
```
brew install eigen
```
- windows
recommended for install [Cygwin](https://www.cygwin.com/) with [CMake](http://www.cmake.org/) and [g++](https://gcc.gnu.org/)
## OpenMp
OpenMP is a widely adopted, portable, and scalable application programming interface (API) for shared-memory parallel programming in C, C++, and Fortran. It provides a high-level, portable abstraction for expressing parallel computation on shared-memory systems.
website [openmp.org](https://www.openmp.org/)
*installation for clara*
- debian package (apt)
OpenMp already installed on ubuntu, according from [askubuntu.com](https://askubuntu.com/questions/144352/how-can-i-install-openmp-in-ubuntu).
if dont have libomp you can install by
```
sudo apt-get install libomp-dev
```
- arch package
for installing libeigen on arch based
```
yay -S openmp
```
- MacOS
install libomp more be tricky, but you can add them (maybe) by this post from [stackoverflow](https://stackoverflow.com/questions/35134681/installing-openmp-on-mac-os-x-10-11)
## Test clara
Clara using [GoogleTest](https://github.com/google/googletest) framework and mocking tools, for installation you can check on [here](https://github.com/google/googletest), or you can just find on the testing script on [``clara_test/run_test``](clara_test/run_test)
## running test clara
```
g++ -pedantic -std=c++11 -Wall -Wextra -Weffc++ -fopenmp -g3 -DDEBUG -isystem $HOME/eigen -I $HOME/clara/include testing/channels.cpp -o channels
```
## running test clara with docker
You can running on docker, docker is container platform that allows you to package an application and its dependencies into single image. this image can then be run on any machine that has docker installed. this make it easy to run application in a consistent way
prerequsites:
- Docker
you can install docker by following [docker official web](https://docs.docker.com/engine/install/ubuntu/) and read the documentation to how to initialization
```
docker build -t clara-test -f ./docker/Dockerfile.clara_test . && docker run -it --name=clara-test clara-test
```
information:
- ``-pedantic`` ensure that the code conforms to the strictest standard of the C++ language
- ``-std=c++11`` specifies that the code should be compiled using c++11
- ``-Wall`` enable all warnings
- ``-Wextra`` enables additional warnings that are not enabled by default
- ``-Weffc++`` enables warnings about potential erroes in the code
- ``-fopenmp`` enables ``OpenMP`` support
- ``-g3`` enable debugging symbol
- ``docker`` best pratices for testing application if you are using windows