Giter Club home page Giter Club logo

qhord's Introduction

qhord

Qhord is a mobile application for interacting with a quantum mechanical system through a musical interface.

IMPORTANT NOTE

This repo has been deprecated. In February 2018, I decided to abandon Kivy as the framework behind Qhord. The primary reason for this was the spotty success I was having with the build system for deploying to mobile devices. We have moved to the Godot engine for continued development and have separated the simulation code into a separate C++ library qsys. Please email me at [email protected] if you have any questions.

logo

Website: qhord

Demo: Youtube

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run this code on your machine you will need:

  • Cython version [0.23, 0.25]
pip install 'cython>=0.23,<0.26'
pip install numpy
pip install scipy

Install necessary system packages

sudo apt install -y \
    python-pip \
    build-essential \
    git \
    python \
    python-dev \
    ffmpeg \
    libsdl2-dev \
    libsdl2-image-dev \
    libsdl2-mixer-dev \
    libsdl2-ttf-dev \
    libportmidi-dev \
    libswscale-dev \
    libavformat-dev \
    libavcodec-dev \
    zlib1g-dev

Then you can install kivy with pip:

pip install kivy
* Mac OSX users may also need the tools 'gst-plugins-bad' and 'gst-plugins-good' in addition to the tools listed on the installation guide
brew install gst-plugins-bad
brew install gst-plugins-good

Running

Once your dependencies are installed and clean, you can run the app with

python -m main

from the /qhord/app folder

Files

  • App - Source Code
    • main.py - code entrance
    • /src - Location of Qsys module - main quantum system
      • assets
      • kv
  • iOS - XCode Project
  • Android - Android builds

Contributing

Please reach out to us at http://qhord.com/ or email Aaron at [email protected] for info about contributing.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

qhord's People

Contributors

aarongrisez avatar michaelseaman avatar samsamsamsamsamsamsam avatar

Watchers

James Cloos avatar Sam Kagan avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.