Skip to content
Snippets Groups Projects
Commit 3ce65428 authored by Antti Soininen's avatar Antti Soininen
Browse files

Add sphinx documentation for directtools Python module. Re #21675

parent 19cc5b21
No related branches found
No related tags found
No related merge requests found
.. _directtools:
======================
:mod:`directtools`
======================
:literal:`directtools` is a Python module for quickly plotting standardized :math:`S(Q,E)` color fill plots as well as line profiles (cuts) in constant :math:`Q` and :math:`E`. The module also provides a few utility functions for inspecting the :math:`S(Q,E)` workspace.
Reference
=========
.. autoclass:: directtools.SampleLogs
:members: __init__
.. automodule:: directtools
:members: nanminmax, plotprofiles, plotconstE, plotconstQ, plotSofQW, subplots,
validQ, wsreport
.. categories:: Techniques
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment