From 8016a0ffa53004358b2406691a89739d4060ce33 Mon Sep 17 00:00:00 2001 From: Jan-Lukas Wynen Date: Mon, 8 Jan 2024 16:24:34 +0100 Subject: [PATCH] Add top-level module docs --- src/scippneutron/__init__.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/scippneutron/__init__.py b/src/scippneutron/__init__.py index 06825df81..f15ae719c 100644 --- a/src/scippneutron/__init__.py +++ b/src/scippneutron/__init__.py @@ -1,7 +1,16 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright (c) 2023 Scipp contributors (https://github.com/scipp) - # flake8: noqa +"""Neutron scattering toolkit built using scipp for Data Reduction. + +ScippNeutron is a generic (as in 'usable by different facilities') +package for data processing in neutron scattering. +It provides coordinate transformations, file I/O, and technique-specific tools. + +See the online documentation for user guides and the API reference: +https://scipp.github.io/scippneutron/ +""" + import importlib.metadata try: