Qsys is a C++ library used in Qhord to simulate a quantum particle.
Website: qhord
Demo: Youtube
This library uses the linear algebra library Eigen, which is already installed in src/Eigen. The depdencies for this project use conan to download the required depdenices. Its documentation can be found here.
this project has some submodule that will need to be cloned
git submodule update --init --recursive
conan is a package manager for C/C++ libraries.
To install, you need Python >=2.7 with pip, which should come by default:
pip install conan
Then, go to the repository's root directory and do
conan install . -s compiler.libcxx=libstdc++11
to install the required libraries that Qsys will need to use when building.
Godot will need to be built first before building QSys. it's under /godot-cpp. more information can be found here. It's already available as a submodule so there is no need to clone godot-cpp.
scons generate_bindings=yes
scons is used to compile QSys:
scons platform=windows/linux/osx
This should create the required shared libraries under: bin/{platform}/libQSys.*.
Note: When running the above script, select your operating system from the list
(ie if you're compiling on Linux, run scons platform=linux).
We are currently using CxxTest to unit-test this library. To generate a test runner for a given test suite, run
cxxtestgen --error-printer -o test_runner.cpp [TestSuite].h
The runner can then be built via
g++ -o runner -I CXXTEST test_runner.cpp
README.md - this file
LICENSE - the MIT license for this project
math.pdf - an outline of the mathematics being implemented by this library
QsysLibraryInterface.md - a brief description of what the API will be
FunctionSpecification.md - a specification for how functions will be written in initialization files
library - a folder containing all the code. Within it there are three subfolders:
include- the header files needed for the tests and source codesrc- the source code for the librarytests- tests for the source code and header files
Please reach out to us at http://qhord.com/ or email Aaron at aaron@qhord.com for info about contributing.
Starting in 2019, we're using Jira! [link].
The current maintainers of this repository are:
- Aaron Grisez - Initial work, Front-End - Aaron Grisez
- Michael Seaman - Just the README Michael Seaman
- Sam Kagan - Library Coding Sam Kagan
- Michael Pollind - Library Coding Michael Pollind
This project is licensed under the MIT License - see the LICENSE file for details