Directions for submitting modules

From HUES Platform Wiki

In order to submit modules to the HUES platform, you must have a HUES account. If you do not have an account, please contact us.

Submitting models and scripts

If your model or script is already accessible online (e.g. via Github or elsewhere) skip to step 3.

  1. Consolidate the files of your model or script within a single directory, if they are not already. This directory can contain subdirectories.
  2. Add the module directory to the HUES team on Bitbucket. See below for detailed instructions. Please note that there is an official size limit on Bitbucket repositories of 1GB (hard limit is 2GB). If your model/script is larger than this, please contact us for an alternative solution. It is possible to keep your model code private to members of the SCCER FEEB&D project - see point 2.4 in the section below for instructions.
  3. Create and complete a page for your module on the HUES wiki using this page. Due to the inner workings of the wiki software, there may be a delay until your model or script shows up on the list of modules on the wiki

Submitting data and snippets

See this page. Dataset files and snippets can be uploaded directly to the platform. Note that uploaded technology and case study data should normally adhere to the HUES data specification.

Submitting collections

If you wish to add a collection containing multiple modules, go to this page and follow the instructions. The pages for these modules must already have been created.

Creating a new Bitbucket repository

  1. Log in to Bitbucket. If you don’t yet have an account, you’ll need to create one and be added to the HUES team. Once you've created an account, email us and we'll add you to the appropriate team(s). IMPORTANT: Your account must be associated with an academic (e.g. ETH, EPFL) email address for the instructions below to work. An Empa email address is not sufficient for this purpose. If you already have an account and it is not associated with an academic email address, you should add this address to your account. If you don’t have an academic email address, contact us.
  2. Click on “Create” at the top of the screen. This will open the “Create a new repository” page. Fill this page in as follows, unless you have a specific reason to do otherwise:
    1. Owner: hues
    2. Name: Preferably the name of your module, but it can also be something else.
    3. Description: Add a short description of your module, if you want.
    4. Access level: Check the box for “This is a private repository” if you only want your module to be accessible to members of the HUES team (includes all members of the SCCER FEEB&D project). If you want your module to be publicly accessible, leave this box unchecked.
    5. Forking: Allow forks
    6. Repository type: Git
    7. Project management: Check both boxes
    8. Language: Optional - choose the programming language of your module. You can also leave this blank.
    9. Hipchat: Do not check
  3. Click “Create repository”
  4. In the “Repository setup” screen, click “Clone in SourceTree” (unless you want to interact with git via command line), and select a destination. A repository for the folder will be created on your local drive. To complete this step, you’ll need to have Atlassian SourceTree installed on your computer.
  5. Add your module files to the newly created folder, commit and push to the remote repository.
  6. Your module should now be visible on the main page of the HUES team.