README.md

timingsrc

Web Documentation for timingsrc available at http://webtiming.github.io/timingsrc/

Timingsrc includes source code and documentation for timing related libraries managed by Multi-Device Timing Community Group

The timingsrc library is available under the LGPL licence.

Timing Object

timingobject

This implements the Timing Object Draft Spec as well as a set of Timing Converters.

Sequencing

sequencing

This implements tools for timed sequencing based on the Timing Object.

Compile Timingsrc v3

Install Node and NPM (Node Packet Manager)

Ubuntu Instructions

Update if necessary

sudo apt update
sudo apt-get update

Add NodeSource repository for Nodejs and NPM (Node Packet Manager)

Install Nodejs on Ubuntu

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -

# script output
# Run `sudo apt-get install -y nodejs` to install Node.js 14.x and npm
# You may also need development tools to build native addons:
#     sudo apt-get install gcc g++ make
# To install the Yarn package manager, run:
#     curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
#     echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
#     sudo apt-get update && sudo apt-get install yarn


# install both node and npm
sudo apt-get install -y nodejs

Install Package Dependencies

• Bundler: Rollup.
• Script Minifier: Terser
• Bundler Plugin: Rollup-Plugin-Terser

Rollup needs global install so that it may be used by the compile.py script.

npm install --global rollup

Then go ahead and install the rest from package.json

cd ~/timingsrc
npm install

Alternatively, install manually

sudo npm install --global rollup
npm install terser
npm install rollup-plugin-terser

Build v3

python3 compile.py v3

Build puts new files in docs/lib

After build - commit all build files

git commit -am "build"
git push

Deploy

Switch to master and merge in new build files from develop.

git checkout master
git merge develop
git push
git checkout develop