Signing Up

1. (Done) User/Developer signs up on BrownDog webpage
   • http://browndog.ncsa.illinois.edu/
2. (Done) User receives email with more information and link to survey
3. (Automatic email) User fills out survey
4. (Done) User is contacted by Brown Dog developer and account is activated
5. (Not for April 4) Tools catalog support for single sign-in

Creating and Adding a New Tool

1. (Gregory Jansen, Rui Liu) Developer downloads BrownDog development environment in docker container (in dockerhub, link on BD webpage)
   • Contains running Clowder instance, Polyglot instance, basic development tools, mabye even an IDE configured and ready to go
   • Contains a bare-bones extractor ready to be modified for a new tool (with comments suggesting where to edit)
   • Contains a bare-bones converter ready to be modified for a new tool (with comments suggesting where to edit)
2. (Gregory Jansen, Smruti Padhy) Developer installs tool, creates BrownDog interface script(s)
   • Adds sample input file(s)
   • Example extractor: imagemagick edge detector
   • Example converter: imagemagick jpg to ico converter
3. (Gregory Jansen, Smruti Padhy)Developer creates dockerfile
   • For extractors this should contain only the tool, its dependencies, and the extractor
   • For converters this should contain the basic Polyglot setup, ideally only the Software Server, the tool, its dependencies, and the converter interface script
4. (Rui Liu) Developer submits tool to Tools Catalog (using BrownDog account)
   
   • (Done) BrownDog interface script(s), dockerfile, sample input, sample output
   • (Done) Through web interface
   • Through script in development environment (probably the ideal way), BD-962
5. (Inna Zharnitsky, Marcus Slavenas) Admin presses button which deploys tool in a separate Clowder/Polyglot sandbox, passes in the given input file, and checks the obtained output file against what is provided
   • Returns pass/fail
6. (Rui Liu) Admin selects instances to deploy interface on
   • e.g. dts-dev or dts
   • selects minimum number of instances to provision (e.g. 5 instances)
   • presses button to deploy
7. (Sandeep Puthanveetil Satheesan) Admin receives status page showing number of tools deployed and where, load on each tool, etc...
   • No support for this at this time.
   • How to pull this from MongoDB

Using a Tool

• (Luigi Marini) API Gateway with keys and tokens (uses Crowd credentials)
  • (Not for April 4) Forwarding user credentials to Clowder
  • Clients
    • (Marcus Slavenas) Matlab
      • Working and includes test script: DAP Outputs, DAP Convert, DTS Extract, and Download File
      • Not yet translated from bd.py: index, find, descriptor distance
    • (Smruti Padhy) R
    • (Luigi Marini) curl
    • (Luigi Marini) Python
    • (Smruti Padhy) Windows
    • (Smruti Padhy) Bookmarklet
    • (Smruti Padhy) Chrome Extension
• (Jong Lee, Eugene Roeder) Simple web interface (requires BrownDog account) 
  
  • Web form with field box for file URL or upload
  • Tool selection dropdown box (means of selecting a specific tool)
  • Output select dropdown box (means of allowing system to select tool)
    • Clowder will run all relevant extractors (obtained by selecting "json" as the output)
    • Polyglot will use I/O-graph
  • Suggestions pane will update below
    • REST API performing this same operation
    • Python code in Jupyter lab notebook
    • R code
    • Matlab code
    • curl commands
    • php