PAW-Manual

Contents:

  • Intro
  • Usage
    • Getting Started
    • Using GrimoireLab-native Features
    • Using Custom scripts
    • Using ElasticWrap
    • Using the GraphQL-API
  • PAW Technical Manual
  • ElasticWrap Documentation
PAW-Manual
  • Usage

Usage

In this section of the PAW manual we will attempt to cover all the information required to effectively use the PAW. From simply convincing it to run, to writing plug-ins to customize data enrichment.

  • Getting Started
    • Setting up Multi-mordred
    • step-by-step: your first analysis project
      • projects.json: defining datasources
      • conf.cfg: defining project pramaters
      • helloWorld.py: adding custom scripting
      • Starting a new mordred instance
      • accessing results via graphql
  • Using GrimoireLab-native Features
    • Using GrimoireLab-native Features with ElasticWrap
  • Using Custom scripts
    • Running the Code
      • Configuring the custom script task
      • script arguments
      • Enabling the custom script phase
      • On running more complex scripts
    • ElasticWrap
    • Using other libraries
  • Using ElasticWrap
    • Why use ElasticWrap?
    • How to use ElasticWrap
      • The ElasticWrap object
      • Searching Data
        • Search Arguments
        • Generic Searching
      • Saving Data
      • Converting Data
  • Using the GraphQL-API
    • Why use GraphQL-API?
    • Technical implementation of GraphQL-API.
    • How to use GraphQL?
    • Integration of GraphQL and ElasticWrap
Previous Next

© Copyright 2023, Aldi Doanta Kurnia, Bernard Johannes Willemsen, Nick Wolters, Rafael Dulfer, Tom Grooters.

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