Nervous Parrot Muttering

    euclidean-rhythms
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    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/euclidean-rhythms@2.0.1/dist/bundle.umd.js
    https://unpkg.com/euclidean-rhythms@2.0.1/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.

    Install

    npm i euclidean-rhythms

    DownloadsWeekly Downloads

    12

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    14.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • mkontogiannis