TODO (use lots of pictures!):
- XSEDE Tutorial content
- BD-tmux
- Adding converters
- Adding extractors
- Dockerization
- Tools catalog
Deploying an Extractor from a Single Call Method
Here is described the entire process for taking a working piece of code and deploying it as a BrownDog Extractor. It is assumed that the method can be invoked from a single call. In this example, we are using the python extractor wrapper and will invoke a python function. In a very similar fashion, a method developed in a language other than python can be invoked using subprocess.
The main steps:
- Dockerize the extractor
- Deploy the extractor
- Add the extractor to the tool catalog
Tools Catalog
Navigate to http://browndog.ncsa.illinois.edu:9000/ and Login using the button at the top right.
NOTE: During the Beta Release the Logins for Brown Dog and the Tools Catalog use different authentication systems so you will need a Username and Password for both.
Either Log in with your SecureSocial password or Sign Up via the link provided.
When you create an account you will receive an email with a link to create the account. Fill out the form and then use your new username and password to log into the Tool Catalog.
Adding or Contributing a Tool to the Tools Catalog
To begin the process of submitting your dockerized tool click "Contribute" at the top of the page.
You will be taken to your individual home page which will show the tools you have already contributed and a button to begin creating a tool "Create Tool".
You will be taken to an entry screen:
Enter:
- Title of the tool
- URL - location of the dockerized tool - *Required
- At a glance - a short description of the tools - Max of 140 characters *Required
- Description - a full description of the tool
- Citation - instructions on how someone would cite the tool if they used it in their work
- YouTube Video URL - link to an instructional video if available
- Tool Type - Indicate if the tool is a Converter or Extractor
and click Submit