Skip to content

Commit

Permalink
Merge pull request #481 from scipp/module-docs
Browse files Browse the repository at this point in the history
Add top-level module docs
  • Loading branch information
jl-wynen committed Jan 17, 2024
2 parents a6ebec5 + 8016a0f commit 6b3f6fd
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/scippneutron/__init__.py
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 6b3f6fd

Please sign in to comment.