Snooz Toolbox
beta-1.2.0

User's Guide

  • Getting Started with Snooz
  • Snooz packages
  • Tools
  • Apps
  • EDFbrowser compatibility

Developer's Guide

  • Technical Overview
  • Developer Installation
  • Run Snooz from the source code
  • Explore examples
  • How Tos
    • How Tos - Package
    • How Tos - Module
    • How Tos - Tool
  • Information
Snooz Toolbox
  • How Tos
  • View page source

How Tos

Before exploring how to create your own package, module, or tool, you need to have a properly configured development environment for Snooz. See Developer Installation for more details.

Ensure that you have created your repository (e.g., my_snooz_repo) to manage your packages. See Run Snooz from the source code for more details.

It is assumed that you have already explored Snooz and have an understanding of its structure. See Explore examples for more details.

  • How Tos - Package
    • How to create create a package
    • How to release a new version of a package
    • How to import a package in Snooz
    • How to update the package version
  • How Tos - Module
    • Before creating your own module
    • How to create a module
    • How to update a module
      • JSON file
      • Module python file
      • Settings View
      • Results View
    • How to design the settings tab
    • How to design the results tab
    • How to show information in the log tab
    • How to add an option to a module
    • How to change the state of a module
    • How to add a resource to a module
    • How to handle exceptions
      • NodeInputException
      • NodeRuntimeException
    • How to run a process over multiple files
    • More information about the modules
    • More information about the tools
    • More information about the packages
  • How Tos - Tool
    • How to create a tool
    • How to create a custom step
    • How to create a configuration step
    • How to use a module’s settings page inside a step
    • How to add a resource to a step
Previous Next

© Copyright 2023, Valorisation Recherche HSCM, Société en Commandite.

Built with Sphinx using a theme provided by Read the Docs.