Code Monkey home page Code Monkey logo

euclidean-rhythms's Introduction

euclidean-rhythms

example branch parameter Codecov npm npm

A micro-library in javascript that calculates the rhythmical patterns of equally distributed pulses in available steps. It implements the bjorklund's algorithm that is described by Godfried Toussaint in The Euclidean algorithm generates traditional musical rhythms

Purpose

I made this library in 2016; I couldn't find an implementation that yields to the expected results as described on the paper above and also being well tested with unit tests and code coverage.

The current solution is a javascript / typescript interpretation of the python code that is retrieved from atonalmicroshores.com

Usage

Node.js

Run npm install euclidean-rhythms

Then in your javascript / typescript code:

const er = require('euclidean-rhythms');

or in es6

import {getPattern} from 'euclidean-rhythms';

let cumbia = getPattern(3, 4);
cumbia should be [ 1, 0, 1, 1 ]

let cinquillo = getPattern(5, 8);
cinquillo should be [ 1, 0, 1, 1, 0, 1, 1, 0 ]

etc ...

Browser

** There is currently no umd bundle support from tsup, will be added as long as there is need for it; in the meantime you can use the older pre-typescript version of it.

Use one of the prepared browser bundles from unpkg.com
https://unpkg.com/[email protected]/dist/bundle.umd.js
https://unpkg.com/[email protected]/dist/bundle.umd.min.js

Then in your javascript code:

var pattern = euclideanRhythms.getPattern(5, 13);
pattern should be : [ 1, 0, 0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 0 ]

Develop

Clone the git repository and cd into it. Run npm run test for executing the unit tests and npm run build to build the ems, commonjs and iife bundles and the type definitions.

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.