Hydra Schema and Folder Structure

Hydra schema

{
"file" : /*full name to the file that will be downloaded on click on download button.
          the file should be located in root.*/
           "myporject.zip",

"thumbnail" : /* full name to an image which is located in root */
          "thumbnail.jpg",

"images" : [    /* 
                        List of images as objects: {image full name : optional description}
                        First image will be loaded on page load by default. All the images should be
                        located in the root folder
                        */
                        {"image1.jpg" : "Grasshopper definition"},
                        {"image2.gif": "Animated Rhino Scene"},
                        {"image3.png": "Dynamo definition"},
                         {"Image4.tiff": "", ...}
                   ],
"videos": [  /*
                  links to embed videos on youtube, Vimeo, etc.: optional description
                  */
                {"https://www.youtube.com/embed/9_u0dnyq2QI", "sunpath tutorial 1"}, ...
                ],

"tags": [  /* list of tags as string */
              "EnergyPlus", "Honeybee", "Energy", ...
           ],

"components": { /* component/node name : number of occurrence in the file */
                          "Honeybee_Set EnergyPlus Zone Loads": 1,
                          "Honeybee_Construct Energy Balance": 1, ... 
                        },

"dependencies": [ /* list of plugins used in the definition */
                           "Human", "Ladybug", "Elk", "Mantis Shrimp", ...
                          ]
}

##Folder Structure

A Hydra folder includes:

• README.md: A markdown file that includes descriptions about the Hydra. The file name should always stay as README.md
• input.json: A json file that follows the above structure. The file name should always stay as input.json (all lower case)
• thumbnail file: An image file that is addressed in input.json as thumbnail
• image files: Any image file that is addressed in input.json
• to be downloaded file: The file that is addressed as "file" in input.json. This file is the only file that will be downloaded

Here is an example with minimum number of files. You can have multiple images if needed.