print · source · login   

Add models

  • upload or remove model files in a benchmark's group by clicking on the "attach" menu
  • only models listed in a model's type data file within the benchmark are included in the distribution zip files.
  • the following types of data files are supported:
  • so edit the data pages for the models in the benchmark by just going to the specific basic model's type data page and click on the "edit" menu and for each model for that type add a line which may be of any of the below formats where the second one is preferred :
    * model.ext
    * [[(Attach:)model.ext]]
    * [[Attach:model.ext]]
    * [[(Attach:)model.ext|alternativeName]]
    * [[ (Attach:)model.ext | alternativeName ]]
  • you must follow this format because otherwise the script generating the distribution zip files cannot parse it
  • verify that the supplied model data is included in the generated distribution zip files:
    • Every 15 minutes a script checks if there are changes to the model data, and will regenerate any affected zip file.
    • Only when logged in to the wiki the Downloads section will show extra:
      • the contents of the zip file in a text file where for each file included both its name and modification time is shown
      • the log of the update script: log.txt
      • within the Downloads all pages are shown with a modification time
    • So after any update to the model data within 15 minutes you can verify it was successful by looking at the Downloads section in which you can easily verify whether the zip contains your supplied models with the right modification times. If not then you can look at the update log.txt file to get a clue what might have gone wrong.
  • optionally you can add an Extra data page of less important models
    • which you don't want to be linked in the Sidebar page because they are not informative for the benchmark
    • but the extra models will, as the other models, be added to the nightly generated zip files in the Downloads page
    • example: we flattened the Register model in the BenchmarkPassport for several data ranges which are listed in the extra data page BenchmarkPassport/ExtraMealy for mealy models which is not linked in the Sidebar however we made a small comment in BenchmarkPassport/Register to it. Latter is optional.
  • notes:
    • we use the listing syntax of pmwiki so that we get a nice listing when viewing this page in pmwiki
    • optionally you can use the Attach syntax of pmwiki so that you can make a direct link to the model's file when viewing this page
    • all other pmwiki content in this file will be ignored when fetching the models from this file
    • thus you are free to add extra documentation using pmwiki markup to make the listing view nicer