@wipp/wsmt

Web Stat Modeling Toolkit (WSMT)

An extensible JavaScript framework for statistical modeling on the web. See it in action on https://isg.nist.gov.

All the functionalities are described in the https://isg.nist.gov/deepzoomweb/help.

Development

Building

We use Grunt for the building and testing scripts. To get started you need to:

1. Install Node.js.
2. Install Grunt via npm install -g grunt-cli.
3. Clone the WSMT repository.
4. Run npm install inside the cloned repository.
5. Install bower npm install -g bower.
6. Run bower install.

You are now ready to build via grunt. If you want to build and execute the tests type grunt all.

Running a local instance

1. Install http-server npm install -g http-server.
2. Start you local server http-server -p 0 . The URL of the running instance will be displayed in the console, for example:

Starting up http-server, serving .
Available on:
  http://127.0.0.1:8080
  http://x.x.x.x:8080

You can now test the system at http://localhost:8080 (for debugging, using the debug.html file at http://localhost:8080/debug.html is more convenient). The port 8080 should be replaced by the actual port displayed by http-server.

Folders contents

The repository is organized as follow:

• / contains the readme, license, build files as well as html files for testing.
• /closure-compiler contains the google closure compiler jar
• /css contains all the project's css files
• /data contains small test datasets
• /images contains the icons used by WSMT
• /libs contains the project dependencies
• /src contains the source code divided in the following sub-folders:
  • /src/ for the core components
  • /src/logic for logic code potentially reused by multiple modules
  • /src/modules for the modules
  • /stc/widgets for UI widgets potentially reused across multiple modules
• /test contains the qUnit tests with one test file for each src file

Modules development

To implement a new module, create a new file your-module.js under src/modules and extend the module class. Add your module in the debug.html file for easy debugging. You should also create the corresponding unit tests under test/modules/your-module.js. Your test file should be included in both test.html and test-debug.html.

Pull requests are appreciated!

License

This software was developed at the National Institute of Standards and Technology by employees of the Federal Government in the course of their official duties. Pursuant to title 17 Section 105 of the United States Code his software is not subject to copyright protection and is in the public domain. This software is an experimental system. NIST assumes no responsibility whatsoever for its use by other parties, and makes no guarantees, expressed or implied, about its quality, reliability, or any other characteristic. We would appreciate acknowledgement if the software is used.