km3test

Project idea and development

This project is intended to serve as the development environment for a test suit for KM3NeT data processing. Check out basic development ideas in the wiki.

You can add your requirements in the issues.

Getting started

Installation

Install the package directly using pip:

pip install git+https://git.km3net.de/jschnabel/km3test

Using the interface

After installation, you can run your first check on a standard offline file by calling the interface

km3test -t filechecks_hasevents myfile.root

If all goes well, you will get a positive test result.

For details on the underlying functionality, see the notebooks and files in /example, call the CLI help km3test -h and the documentation.

Contents:

• Examples
  • Collection of Examples
• Filing Bugs or Feature Requests
• Improve
  • Make a Fork
  • Clone your Fork to your PC
  • Keep your Fork Up to Date
  • Push your changes to Gitlab regularly
  • Install in Developer Mode
  • Running the Test Suite
  • Time to Code
  • Code Style
  • Create a Merge Request (aka Pull Request)
• Changelog
  • Unreleased changes
• API Reference
  • km3test
• Code Coverage
• Source (Git)

Indices and tables

• Index

• Module Index

• Search Page