AIT Guide Documentation

• 1. Introduction
  • 1.1. Assumed User
  • 1.2. What is AIT?
    • 1.2.1. What is AIT development environment?
      • 1.2.1.1. Docker images for AIT developers
      • 1.2.1.2. AIT Template
      • 1.2.1.3. Prerequisites
  • 1.3. List of published AITs
• 2. Prerequisites and installation
  • 2.1. Prerequisites of installation
    • 2.1.1. Required Software
    • 2.1.2. Operability confirmed environment
  • 2.2. Installation
    • 2.2.1. Structure of source files.
    • 2.2.2. Installation of Docker
• 3. Tutorial
  • 3.1. Preparation
    • 3.1.1. User workflow
    • 3.1.2. Fork the AIT template
    • 3.1.3. Change AIT repository name
      • 3.1.3.1. Recommended naming convention of AIT
    • 3.1.4. Clone the AIT repository
    • 3.1.5. Edit readme.md
    • 3.1.6. Launch development envionment
      • 3.1.6.1. Screenshots after launch
      • 3.1.6.2. Development work flow
  • 3.2. Experimentation within Jupyter Lab.
    • 3.2.1. Environmental information
    • 3.2.2. Jupyter Lab Usage
  • 3.3. AIT development
    • 3.3.1. Edit my_ait.ipynb
    • 3.3.2. The structure of my_ait.ipynb
      • 3.3.2.1. #3 Dependency Management area
      • 3.3.2.2. #4 Importing Libraries area
      • 3.3.2.3. #5 Manifest Generation area
      • 3.3.2.4. #6 Prepare for the Input area
      • 3.3.2.5. #8 Functions definitions area
        • 3.3.2.5.1. result output functions: Report/Measures
        • 3.3.2.5.2. result output functions: Report/Resources
        • 3.3.2.5.3. result output functions: downloads
      • 3.3.2.6. #9 Main Algorithms area
      • 3.3.2.7. #11 License area
    • 3.3.3. Check program execution
  • 3.4. Unit test
    • 3.4.1. Prepare for unit test
      • 3.4.1.1. Preparation of input data for unit test
      • 3.4.1.2. Register test input
    • 3.4.2. Running unit test
      • 3.4.2.1. Generation of the AIT Execution Program
      • 3.4.2.2. Copying your own python modules (optional)
      • 3.4.2.3. Preparation for unit test execution
      • 3.4.2.4. Execute unit test
    • 3.4.3. Evaluate unit test
  • 3.5. Preparing registration for Qunomon
    • 3.5.1. Add environment setup processes that do not use the AIT-SDK
    • 3.5.2. Generate Third-party Notice
    • 3.5.3. create zip file
  • 3.6. Integration test
    • 3.6.1. Prepare for integration test
    • 3.6.2. Running integration test
    • 3.6.3. Evaluate integration test
    • 3.6.4. Modifying AIT
  • 3.7. Publishing AIT
    • 3.7.1. Register on GITHUB
      • 3.7.1.1. Select upload inventory
      • 3.7.1.2. Enter commit comment
      • 3.7.1.3. Check repository URL
    • 3.7.2. Register on AIT-HUB
• 4. Appendix
  • 4.1. Pre-installed AITs
  • 4.2. FAQ
  • 4.3. Terminology
    • 4.3.1. Technical terms related to the Qunomon testbed and/or AIT
    • 4.3.2. Other general technical terms