Need help? Contact us:
support@codeocean.com

Using an Interface

If an author has created a graphic user interface for her algorithm, you will be directed to the Interface tab when you open the algorithm from your dashboard or the Explore page. To use the interface:

  1. Change the parameters' values defined by the author in the left pane.

  2. Click Run.

  3. Once the run ends you will see the results in the main Results pane.

Creating an Interface

You can easily add an graphical interface to any algorithm right from the Interface tab. This will let other users interact with the code in a more accessible and friendly fashion, by entering or choosing the values for the set of parameters you make available to them.

The interface simply builds on top of command-line parameters, so supporting it will require you to adapt the code to accept optional command-line parameters (remember some users may run your code directly from the Code tab, so make sure to provide default parameters).

To design your interface, start by selecting the type of parameter you'd like to add on the bottom left. It can be a text field, a drop-down list of pre-defined values, or an input file selector. Configure the parameter and click Save, repeating these steps as needed.

Now click Run and wait for the run to finish. Click Add Result File and select the result file you'd like displayed in the Results pane every time an Interface run finishes. Finally, click Save. Repeat this for any result files you want the user to see.