From ed1b26f54217fd37bd56925a3df35defb00f2462 Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 11:59:56 -0400 Subject: [PATCH 01/13] ' Added Sphinx documentation to SHIVER. --- docs/Makefile | 21 ++++++++++ docs/make.bat | 37 +++++++++++++++++ docs/source/api.rst | 7 ++++ docs/source/conf.py | 58 ++++++++++++++++++++++++++ docs/source/deploy.rst | 69 +++++++++++++++++++++++++++++++ docs/source/generated/shiver.rst | 16 +++++++ docs/source/getting_started.rst | 67 ++++++++++++++++++++++++++++++ docs/source/index.rst | 36 ++++++++++++++++ docs/source/reading_materials.rst | 29 +++++++++++++ docs/source/usage.rst | 43 +++++++++++++++++++ environment.yml | 2 + 11 files changed, 385 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/api.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/deploy.rst create mode 100644 docs/source/generated/shiver.rst create mode 100644 docs/source/getting_started.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/reading_materials.rst create mode 100644 docs/source/usage.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..9d29d715 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,21 @@ +# Purpose: Convenience scripts to simplify some common Sphinx operations, such as rendering the content. + +# Minimal makefile for Sphinx documentation + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..5a41d8d3 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,37 @@ +REM Purpose: Convenience scripts to simplify some common Sphinx operations, such as rendering the content. + +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 00000000..5afcf411 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,7 @@ +API +=== + +.. autosummary:: + :toctree: generated + + shiver diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..d39ff684 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,58 @@ +""" + Purpose: A Python script holding the configuration of the project. Contains the project + name and release information as well as some extra configuration keys. +""" + +import versioningit + +try: + import shiver +except ImportError: + import os + import sys + + sys.path.insert(0, os.path.abspath("../../src")) + +# Configuration file for the Sphinx documentation builder. + +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = "SHIVER" +copyright = "2022, ORNL" +author = "ORNL" +version = versioningit.get_version("../../") +release = ".".join(version.split(".")[:-1]) + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", +] + +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} +intersphinx_disabled_domains = ["std"] + +templates_path = ["_templates"] +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "sphinx_rtd_theme" + +html_theme_options = {"style_nav_header_background": "#472375"} + +epub_show_urls = "footnote" diff --git a/docs/source/deploy.rst b/docs/source/deploy.rst new file mode 100644 index 00000000..7c5b5e9c --- /dev/null +++ b/docs/source/deploy.rst @@ -0,0 +1,69 @@ +Deployments +=========== + +.. _deploy: + +Branches +-------- + +The repository contains three main-permanent branches: + +* `next `_ + +This is the central branch that all other branches are created by +``e.g., git checkout -b next`` + +* `main `_ + +No development allowed in this branch. The branch is a result of the next branch +(for production release). The next branch is merged into this one manually. +When you put the tag (without rc suffix), this should be updated from +next manually; more on tags in the `Tags`_ section. + +* `qa `_ + +No development allowed in this branch. The branch is a results of the next branch +(for the qa release). The next branch is merged into this one manually. When +you put the tag (with rc suffix), this should be updated from next manually; +more on tahs in the `Tags`_ section. + +Code Contribution +----------------- + +After creating a temporary branch from *next* locally, developers can make +changes to the code. Before commiting-pushing any changes on the remote +repository: + +1. Run pre-commit manually: ``pre-commit run --all-files`` and/or set it +before each commit ``pre-commit install`` + +2. Run all tests (including your newly created ones, if necessary) within +``pytest`` to ensure everything passes. + + +.. note:: Additional Information Regarding Mantid + + Some mantid algorithms/concepts used in the project: `ConvertToMD `_, + `MDNorm `_ and ``Workspace`` dimensionality. + + In ``SHIVER``, ``mantid`` algorithms are executed asynchronously using the ``AlgorithmManager``. + This allows the progress bar to be displayed, while waiting for the algorithm completion, and + the GUI to be responsive. + +.. _Tags: + +Tags +---- + +The branches: ``qa`` and ``main`` need to be approved with the latest code +from ``next``. After approval, we assign a tag as follows: + +From command line on the corresponding branch ``(main/qa)``: + +.. code-block:: sh + + git tag + git push origin -tags + +Click `here `_ +for more information. diff --git a/docs/source/generated/shiver.rst b/docs/source/generated/shiver.rst new file mode 100644 index 00000000..5dc68ca4 --- /dev/null +++ b/docs/source/generated/shiver.rst @@ -0,0 +1,16 @@ +shiver +====== + +.. automodule:: shiver + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + main diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst new file mode 100644 index 00000000..1c501465 --- /dev/null +++ b/docs/source/getting_started.rst @@ -0,0 +1,67 @@ +Getting Started +=============== + +.. _getting_started: + + + +Instructions for SHIVER development +----------------------------------- + +Conda Configuration +``````````````````` +Create and activate conda environment for ``SHIVER``. + +.. code-block:: sh + + conda env create --file environment.yml + # or + mamba env create --file environment.yml + + conda activate shiver + +Install ``SHIVER`` (in `editable mode `_) and start application + +.. code-block:: sh + + python -m pip install -e . + + shiver + +If it has been a while, once can update using + +.. code-block:: sh + + conda activate shiver + conda env update --file environment.yml --prune + +To start ``SHIVER`` from within the Mantid workbench, start ``mantidworkbench`` then run the following in the +``IPython`` console + +.. code-block:: sh + + from shiver import Shiver + s = Shiver() + s.show() + +**For Developers** + +To run all tests for ``SHIVER`` + +.. code-block:: sh + + pytest + #or + python -m pytest + +To run ``pre-commit`` manually + +.. code-block:: sh + + pre-commit run --all-files + +Or to set the ``pre-commit`` hook before each ``git`` commit + +.. code-block:: sh + + pre-commit install diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..96b939d1 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,36 @@ +.. Purpose: The root document of the project, which serves as welcome page and contains the root +.. of the "table of contents tree" (or toctree). + +Welcome to SHIVER's documentation! +================================== +The Spectroscopy HIstogram Visulizer for Event Reduction **(SHIVER)** is a tool to +allow examination of time of flight inelastic neutron data, from single crystal, +direct geometry experiments. It is intended to perform the following tasks: + +* Transform time of flight data from multiple orientations into a single intermediate + structure in units of reciprocal space and energy transfer + + +* Allow slicing of the intermediate file and creation of histograms containing S(**Q**, ∆ *E*) + with various dimensionality + + +* Visualize the histograms + +Check out the :doc:`usage` section for further information, including :ref:`installation` +steps for this project. + +.. note:: + + This project is under active development. + +Contents +-------- + +.. toctree:: + + getting_started + usage + api + deploy + reading_materials diff --git a/docs/source/reading_materials.rst b/docs/source/reading_materials.rst new file mode 100644 index 00000000..4b244216 --- /dev/null +++ b/docs/source/reading_materials.rst @@ -0,0 +1,29 @@ +Additional Reading Materials +============================ + +.. _reading_materials: + +Suggested Reading Material +-------------------------- + +Physics: Conservation of Energy & Momentum + +Math - Geometry/Trigonometry: + +* Coordinate system + +* Pythongorean theorem generalization/ Law of Cosines + +* Scalar and Vector products + +* `Euclidean vector concepts `_ + +Neutrons Scattering ORNL `(Slides) `_ + +Neutron and X-Ray Spectroscopy `(Book) `_ + +Research Papers: + +* Efficient Data Management in Neutron Scattering Data Reduction Workflows at ORNL `(paper) `_ + +* Efficient Data Reduction for Time-of-Flight Neutron Scattering Experiments on Single Crystals `(paper) `_ diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 00000000..251f4629 --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,43 @@ +Usage +===== + +.. _installation: + +Installation +------------ + + +Under Construction! + +Application Information +----------------------- + +``SHIVER`` is a desktop application for generating histograms from direct +geometry inelastic data related to spectroscopy event reduction. It is +built as a python package and can be used either as a standalone application +or as a package imported in Mantid workbench. + +In the Main tab, the user can load Nexus files to create histrograms. +Additional parameters are set to in the main and generate tab to alter and +plot the data. + +.. note:: + `Github Shiver Repository `_ + +Technologies +------------ + +The project is written in Python (>=3.8). It is highly dependent on `Manitd `_. +The Graphical User Interface (GUI) is based on `QtPy `_ (version is defined by Mantid) + + +Project Structure +----------------- + +The main code of the project is at src/shiver and the tests are at ``tests/`` +folders. The project contains additional scripts at ``DGS_SC_scripts/`` folder, +which are initial (development) legacy scripts that ``SHIVER`` was created around +them. + +The code follows the `MVP (Model-View-Presenter) `_ Thus, +all current and future changes will follow this pattern. diff --git a/environment.yml b/environment.yml index 80a479a6..feb3a4c1 100644 --- a/environment.yml +++ b/environment.yml @@ -10,6 +10,8 @@ dependencies: - pytest=7.2.1 - pytest-qt=4.2.0 - pytest-cov=4.0.0 + - sphinx - pip - pip: - https://oncat.ornl.gov/packages/pyoncat-1.4.1-py3-none-any.whl + - sphinx-rtd-theme From 76253a77042ff09f1d9f91df901e532f3a23ca51 Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 13:58:19 -0400 Subject: [PATCH 02/13] Added documentation for the repo files. --- docs/source/api.rst | 7 -- docs/source/conf.py | 24 +++--- .../DGS_SC_scripts.define_data_example1.rst | 16 ++++ ..._scripts.define_data_example_polarized.rst | 16 ++++ .../DGS_SC_scripts.define_slices_example1.rst | 16 ++++ ...cripts.define_slices_example_polarized.rst | 16 ++++ .../generated/DGS_SC_scripts.oncat_util.rst | 20 +++++ .../DGS_SC_scripts.reduce_data_to_MDE.rst | 20 +++++ .../generated/DGS_SC_scripts.slice_utils.rst | 26 +++++++ docs/source/generated/shiver.rst | 16 ---- docs/source/generated/src.shiver._version.rst | 4 + ...hiver.models.convert_dgs_to_single_mde.rst | 20 +++++ .../src.shiver.models.corrections.rst | 22 ++++++ .../generated/src.shiver.models.generate.rst | 28 +++++++ .../src.shiver.models.generate_dgs_mde.rst | 20 +++++ .../generated/src.shiver.models.help.rst | 16 ++++ .../generated/src.shiver.models.histogram.rst | 32 ++++++++ .../generated/src.shiver.models.makeslice.rst | 20 +++++ .../generated/src.shiver.models.sample.rst | 20 +++++ .../generated/src.shiver.models.utils.rst | 16 ++++ .../src.shiver.presenters.generate.rst | 26 +++++++ .../src.shiver.presenters.histogram.rst | 20 +++++ .../src.shiver.presenters.sample.rst | 20 +++++ docs/source/generated/src.shiver.shiver.rst | 20 +++++ docs/source/generated/src.shiver.version.rst | 4 + .../src.shiver.views.advanced_options.rst | 27 +++++++ .../src.shiver.views.corrections.rst | 20 +++++ .../generated/src.shiver.views.data.rst | 26 +++++++ .../generated/src.shiver.views.generate.rst | 29 ++++++++ .../generated/src.shiver.views.histogram.rst | 20 +++++ .../src.shiver.views.histogram_parameters.rst | 29 ++++++++ .../src.shiver.views.invalid_styles.rst | 4 + .../src.shiver.views.loading_buttons.rst | 20 +++++ .../generated/src.shiver.views.mainwindow.rst | 20 +++++ .../generated/src.shiver.views.oncat.rst | 31 ++++++++ .../generated/src.shiver.views.plots.rst | 16 ++++ .../src.shiver.views.polarized_options.rst | 27 +++++++ .../src.shiver.views.reduction_parameters.rst | 20 +++++ .../generated/src.shiver.views.sample.rst | 22 ++++++ .../src.shiver.views.workspace_tables.rst | 33 +++++++++ docs/source/generated/tests.conftest.rst | 17 +++++ .../generated/tests.data.define_data.rst | 16 ++++ .../tests.models.test_gather_history.rst | 16 ++++ .../tests.models.test_generate_model.rst | 17 +++++ .../tests.models.test_generatemde.rst | 24 ++++++ .../tests.models.test_histogram_saving.rst | 16 ++++ .../generated/tests.models.test_load.rst | 20 +++++ .../generated/tests.models.test_makeslice.rst | 18 +++++ ...test_sample_parameters_buttons_actions.rst | 20 +++++ ....test_sample_parameters_invalid_inputs.rst | 19 +++++ .../generated/tests.models.test_save.rst | 16 ++++ .../tests.models.test_symmetry_operations.rst | 20 +++++ .../generated/tests.models.test_utils.rst | 16 ++++ .../generated/tests.views.test_correction.rst | 16 ++++ .../generated/tests.views.test_dimensions.rst | 23 ++++++ .../generated/tests.views.test_generate.rst | 20 +++++ .../generated/tests.views.test_histogram.rst | 21 ++++++ .../tests.views.test_histogram_button.rst | 17 +++++ .../tests.views.test_loading_buttons.rst | 17 +++++ .../generated/tests.views.test_mainwindow.rst | 16 ++++ .../tests.views.test_mde_workspaces.rst | 17 +++++ .../tests.views.test_mdh_workspaces.rst | 20 +++++ .../generated/tests.views.test_oncat.rst | 33 +++++++++ .../tests.views.test_polarized_options.rst | 28 +++++++ .../tests.views.test_projections.rst | 18 +++++ .../generated/tests.views.test_raw_data.rst | 20 +++++ ...views.test_reduction_parameters_inputs.rst | 23 ++++++ ...s.views.test_sample_parameters_buttons.rst | 22 ++++++ ...ts.views.test_sample_parameters_inputs.rst | 24 ++++++ docs/source/index.rst | 3 +- docs/source/reading_materials.rst | 29 -------- docs/source/repo_doc.rst | 74 +++++++++++++++++++ 72 files changed, 1417 insertions(+), 68 deletions(-) delete mode 100644 docs/source/api.rst create mode 100644 docs/source/generated/DGS_SC_scripts.define_data_example1.rst create mode 100644 docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst create mode 100644 docs/source/generated/DGS_SC_scripts.define_slices_example1.rst create mode 100644 docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst create mode 100644 docs/source/generated/DGS_SC_scripts.oncat_util.rst create mode 100644 docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst create mode 100644 docs/source/generated/DGS_SC_scripts.slice_utils.rst delete mode 100644 docs/source/generated/shiver.rst create mode 100644 docs/source/generated/src.shiver._version.rst create mode 100644 docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst create mode 100644 docs/source/generated/src.shiver.models.corrections.rst create mode 100644 docs/source/generated/src.shiver.models.generate.rst create mode 100644 docs/source/generated/src.shiver.models.generate_dgs_mde.rst create mode 100644 docs/source/generated/src.shiver.models.help.rst create mode 100644 docs/source/generated/src.shiver.models.histogram.rst create mode 100644 docs/source/generated/src.shiver.models.makeslice.rst create mode 100644 docs/source/generated/src.shiver.models.sample.rst create mode 100644 docs/source/generated/src.shiver.models.utils.rst create mode 100644 docs/source/generated/src.shiver.presenters.generate.rst create mode 100644 docs/source/generated/src.shiver.presenters.histogram.rst create mode 100644 docs/source/generated/src.shiver.presenters.sample.rst create mode 100644 docs/source/generated/src.shiver.shiver.rst create mode 100644 docs/source/generated/src.shiver.version.rst create mode 100644 docs/source/generated/src.shiver.views.advanced_options.rst create mode 100644 docs/source/generated/src.shiver.views.corrections.rst create mode 100644 docs/source/generated/src.shiver.views.data.rst create mode 100644 docs/source/generated/src.shiver.views.generate.rst create mode 100644 docs/source/generated/src.shiver.views.histogram.rst create mode 100644 docs/source/generated/src.shiver.views.histogram_parameters.rst create mode 100644 docs/source/generated/src.shiver.views.invalid_styles.rst create mode 100644 docs/source/generated/src.shiver.views.loading_buttons.rst create mode 100644 docs/source/generated/src.shiver.views.mainwindow.rst create mode 100644 docs/source/generated/src.shiver.views.oncat.rst create mode 100644 docs/source/generated/src.shiver.views.plots.rst create mode 100644 docs/source/generated/src.shiver.views.polarized_options.rst create mode 100644 docs/source/generated/src.shiver.views.reduction_parameters.rst create mode 100644 docs/source/generated/src.shiver.views.sample.rst create mode 100644 docs/source/generated/src.shiver.views.workspace_tables.rst create mode 100644 docs/source/generated/tests.conftest.rst create mode 100644 docs/source/generated/tests.data.define_data.rst create mode 100644 docs/source/generated/tests.models.test_gather_history.rst create mode 100644 docs/source/generated/tests.models.test_generate_model.rst create mode 100644 docs/source/generated/tests.models.test_generatemde.rst create mode 100644 docs/source/generated/tests.models.test_histogram_saving.rst create mode 100644 docs/source/generated/tests.models.test_load.rst create mode 100644 docs/source/generated/tests.models.test_makeslice.rst create mode 100644 docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst create mode 100644 docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst create mode 100644 docs/source/generated/tests.models.test_save.rst create mode 100644 docs/source/generated/tests.models.test_symmetry_operations.rst create mode 100644 docs/source/generated/tests.models.test_utils.rst create mode 100644 docs/source/generated/tests.views.test_correction.rst create mode 100644 docs/source/generated/tests.views.test_dimensions.rst create mode 100644 docs/source/generated/tests.views.test_generate.rst create mode 100644 docs/source/generated/tests.views.test_histogram.rst create mode 100644 docs/source/generated/tests.views.test_histogram_button.rst create mode 100644 docs/source/generated/tests.views.test_loading_buttons.rst create mode 100644 docs/source/generated/tests.views.test_mainwindow.rst create mode 100644 docs/source/generated/tests.views.test_mde_workspaces.rst create mode 100644 docs/source/generated/tests.views.test_mdh_workspaces.rst create mode 100644 docs/source/generated/tests.views.test_oncat.rst create mode 100644 docs/source/generated/tests.views.test_polarized_options.rst create mode 100644 docs/source/generated/tests.views.test_projections.rst create mode 100644 docs/source/generated/tests.views.test_raw_data.rst create mode 100644 docs/source/generated/tests.views.test_reduction_parameters_inputs.rst create mode 100644 docs/source/generated/tests.views.test_sample_parameters_buttons.rst create mode 100644 docs/source/generated/tests.views.test_sample_parameters_inputs.rst delete mode 100644 docs/source/reading_materials.rst create mode 100644 docs/source/repo_doc.rst diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 5afcf411..00000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,7 +0,0 @@ -API -=== - -.. autosummary:: - :toctree: generated - - shiver diff --git a/docs/source/conf.py b/docs/source/conf.py index d39ff684..b1449397 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,16 +2,12 @@ Purpose: A Python script holding the configuration of the project. Contains the project name and release information as well as some extra configuration keys. """ - +import os +import sys import versioningit -try: - import shiver -except ImportError: - import os - import sys - sys.path.insert(0, os.path.abspath("../../src")) +sys.path.insert(0, os.path.abspath("../../")) # Configuration file for the Sphinx documentation builder. @@ -21,11 +17,11 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "SHIVER" -copyright = "2022, ORNL" -author = "ORNL" -version = versioningit.get_version("../../") -release = ".".join(version.split(".")[:-1]) +PROJECT = "SHIVER" +COPYRIGHT = "2022, ORNL" +AUTHOR = "ORNL" +VERSION = versioningit.get_version("../../") +RELEASE = ".".join(VERSION.split(".")[:-1]) # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -51,8 +47,8 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "sphinx_rtd_theme" +HTML_THEME = "sphinx_rtd_theme" html_theme_options = {"style_nav_header_background": "#472375"} -epub_show_urls = "footnote" +EPUB_SHOW_URLS = "footnote" diff --git a/docs/source/generated/DGS_SC_scripts.define_data_example1.rst b/docs/source/generated/DGS_SC_scripts.define_data_example1.rst new file mode 100644 index 00000000..efdb5946 --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.define_data_example1.rst @@ -0,0 +1,16 @@ +DGS\_SC\_scripts.define\_data\_example1 +======================================= + +.. automodule:: DGS_SC_scripts.define_data_example1 + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + define_data_set diff --git a/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst b/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst new file mode 100644 index 00000000..ec830f03 --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst @@ -0,0 +1,16 @@ +DGS\_SC\_scripts.define\_data\_example\_polarized +================================================= + +.. automodule:: DGS_SC_scripts.define_data_example_polarized + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + define_data_set diff --git a/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst b/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst new file mode 100644 index 00000000..03612029 --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst @@ -0,0 +1,16 @@ +DGS\_SC\_scripts.define\_slices\_example1 +========================================= + +.. automodule:: DGS_SC_scripts.define_slices_example1 + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + define_data_slices diff --git a/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst b/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst new file mode 100644 index 00000000..fb2a20c0 --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst @@ -0,0 +1,16 @@ +DGS\_SC\_scripts.define\_slices\_example\_polarized +=================================================== + +.. automodule:: DGS_SC_scripts.define_slices_example_polarized + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + define_data_slices diff --git a/docs/source/generated/DGS_SC_scripts.oncat_util.rst b/docs/source/generated/DGS_SC_scripts.oncat_util.rst new file mode 100644 index 00000000..2035e18c --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.oncat_util.rst @@ -0,0 +1,20 @@ +DGS\_SC\_scripts.oncat\_util +============================ + +.. automodule:: DGS_SC_scripts.oncat_util + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + get_data_from_oncat + get_dataset_info + get_dataset_names + oncat_login + write_json_from_oncat diff --git a/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst b/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst new file mode 100644 index 00000000..2a84ddef --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst @@ -0,0 +1,20 @@ +DGS\_SC\_scripts.reduce\_data\_to\_MDE +====================================== + +.. automodule:: DGS_SC_scripts.reduce_data_to_MDE + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + detector_geometry_correction + generate_BG_mde + generate_mde + polarizer_transmission + reduce_data_to_MDE diff --git a/docs/source/generated/DGS_SC_scripts.slice_utils.rst b/docs/source/generated/DGS_SC_scripts.slice_utils.rst new file mode 100644 index 00000000..cd42e837 --- /dev/null +++ b/docs/source/generated/DGS_SC_scripts.slice_utils.rst @@ -0,0 +1,26 @@ +DGS\_SC\_scripts.slice\_utils +============================= + +.. automodule:: DGS_SC_scripts.slice_utils + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + SaveMDToAscii + dim2array + filter_large_error + gauss + make_slice + make_slices_FR_corrected + plot_slice + plot_w_parameters + set_axes_parameters + slice_des2str + subtract_incoherent diff --git a/docs/source/generated/shiver.rst b/docs/source/generated/shiver.rst deleted file mode 100644 index 5dc68ca4..00000000 --- a/docs/source/generated/shiver.rst +++ /dev/null @@ -1,16 +0,0 @@ -shiver -====== - -.. automodule:: shiver - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - main diff --git a/docs/source/generated/src.shiver._version.rst b/docs/source/generated/src.shiver._version.rst new file mode 100644 index 00000000..0473e6be --- /dev/null +++ b/docs/source/generated/src.shiver._version.rst @@ -0,0 +1,4 @@ +src.shiver.\_version +==================== + +.. automodule:: src.shiver._version diff --git a/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst b/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst new file mode 100644 index 00000000..b95521e3 --- /dev/null +++ b/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst @@ -0,0 +1,20 @@ +src.shiver.models.convert\_dgs\_to\_single\_mde +=============================================== + +.. automodule:: src.shiver.models.convert_dgs_to_single_mde + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ConvertDGSToSingleMDE diff --git a/docs/source/generated/src.shiver.models.corrections.rst b/docs/source/generated/src.shiver.models.corrections.rst new file mode 100644 index 00000000..2bda1ddf --- /dev/null +++ b/docs/source/generated/src.shiver.models.corrections.rst @@ -0,0 +1,22 @@ +src.shiver.models.corrections +============================= + +.. automodule:: src.shiver.models.corrections + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ApplyDetailedBalanceMDObserver + CorrectionsModel + DgsScatteredTransmissionCorrectionMDObserver diff --git a/docs/source/generated/src.shiver.models.generate.rst b/docs/source/generated/src.shiver.models.generate.rst new file mode 100644 index 00000000..22366969 --- /dev/null +++ b/docs/source/generated/src.shiver.models.generate.rst @@ -0,0 +1,28 @@ +src.shiver.models.generate +========================== + +.. automodule:: src.shiver.models.generate + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + gather_mde_config_dict + + + + + + .. rubric:: Classes + + .. autosummary:: + + GenerateMDEObserver + GenerateModel + SaveMDObserver diff --git a/docs/source/generated/src.shiver.models.generate_dgs_mde.rst b/docs/source/generated/src.shiver.models.generate_dgs_mde.rst new file mode 100644 index 00000000..c97a1b59 --- /dev/null +++ b/docs/source/generated/src.shiver.models.generate_dgs_mde.rst @@ -0,0 +1,20 @@ +src.shiver.models.generate\_dgs\_mde +==================================== + +.. automodule:: src.shiver.models.generate_dgs_mde + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + GenerateDGSMDE diff --git a/docs/source/generated/src.shiver.models.help.rst b/docs/source/generated/src.shiver.models.help.rst new file mode 100644 index 00000000..3ee2799e --- /dev/null +++ b/docs/source/generated/src.shiver.models.help.rst @@ -0,0 +1,16 @@ +src.shiver.models.help +====================== + +.. automodule:: src.shiver.models.help + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + help_function diff --git a/docs/source/generated/src.shiver.models.histogram.rst b/docs/source/generated/src.shiver.models.histogram.rst new file mode 100644 index 00000000..354e5f2c --- /dev/null +++ b/docs/source/generated/src.shiver.models.histogram.rst @@ -0,0 +1,32 @@ +src.shiver.models.histogram +=========================== + +.. automodule:: src.shiver.models.histogram + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + dim2array + filter_ws + get_frame + get_num_non_integrated_dims + + + + + + .. rubric:: Classes + + .. autosummary:: + + ADSObserver + FileLoadingObserver + HistogramModel + MakeSliceObserver diff --git a/docs/source/generated/src.shiver.models.makeslice.rst b/docs/source/generated/src.shiver.models.makeslice.rst new file mode 100644 index 00000000..99e4e223 --- /dev/null +++ b/docs/source/generated/src.shiver.models.makeslice.rst @@ -0,0 +1,20 @@ +src.shiver.models.makeslice +=========================== + +.. automodule:: src.shiver.models.makeslice + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + MakeSlice diff --git a/docs/source/generated/src.shiver.models.sample.rst b/docs/source/generated/src.shiver.models.sample.rst new file mode 100644 index 00000000..78ed5f27 --- /dev/null +++ b/docs/source/generated/src.shiver.models.sample.rst @@ -0,0 +1,20 @@ +src.shiver.models.sample +======================== + +.. automodule:: src.shiver.models.sample + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + SampleModel diff --git a/docs/source/generated/src.shiver.models.utils.rst b/docs/source/generated/src.shiver.models.utils.rst new file mode 100644 index 00000000..1cd0e6b0 --- /dev/null +++ b/docs/source/generated/src.shiver.models.utils.rst @@ -0,0 +1,16 @@ +src.shiver.models.utils +======================= + +.. automodule:: src.shiver.models.utils + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + flatten_list diff --git a/docs/source/generated/src.shiver.presenters.generate.rst b/docs/source/generated/src.shiver.presenters.generate.rst new file mode 100644 index 00000000..3403604d --- /dev/null +++ b/docs/source/generated/src.shiver.presenters.generate.rst @@ -0,0 +1,26 @@ +src.shiver.presenters.generate +============================== + +.. automodule:: src.shiver.presenters.generate + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + translate_filelist_to_string + + + + + + .. rubric:: Classes + + .. autosummary:: + + GeneratePresenter diff --git a/docs/source/generated/src.shiver.presenters.histogram.rst b/docs/source/generated/src.shiver.presenters.histogram.rst new file mode 100644 index 00000000..70129e41 --- /dev/null +++ b/docs/source/generated/src.shiver.presenters.histogram.rst @@ -0,0 +1,20 @@ +src.shiver.presenters.histogram +=============================== + +.. automodule:: src.shiver.presenters.histogram + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + HistogramPresenter diff --git a/docs/source/generated/src.shiver.presenters.sample.rst b/docs/source/generated/src.shiver.presenters.sample.rst new file mode 100644 index 00000000..cd7292a7 --- /dev/null +++ b/docs/source/generated/src.shiver.presenters.sample.rst @@ -0,0 +1,20 @@ +src.shiver.presenters.sample +============================ + +.. automodule:: src.shiver.presenters.sample + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + SamplePresenter diff --git a/docs/source/generated/src.shiver.shiver.rst b/docs/source/generated/src.shiver.shiver.rst new file mode 100644 index 00000000..c9de3584 --- /dev/null +++ b/docs/source/generated/src.shiver.shiver.rst @@ -0,0 +1,20 @@ +src.shiver.shiver +================= + +.. automodule:: src.shiver.shiver + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Shiver diff --git a/docs/source/generated/src.shiver.version.rst b/docs/source/generated/src.shiver.version.rst new file mode 100644 index 00000000..93f28b75 --- /dev/null +++ b/docs/source/generated/src.shiver.version.rst @@ -0,0 +1,4 @@ +src.shiver.version +================== + +.. automodule:: src.shiver.version diff --git a/docs/source/generated/src.shiver.views.advanced_options.rst b/docs/source/generated/src.shiver.views.advanced_options.rst new file mode 100644 index 00000000..c4fa336a --- /dev/null +++ b/docs/source/generated/src.shiver.views.advanced_options.rst @@ -0,0 +1,27 @@ +src.shiver.views.advanced\_options +================================== + +.. automodule:: src.shiver.views.advanced_options + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + return_valid + + + + + + .. rubric:: Classes + + .. autosummary:: + + ADValidator + AdvancedDialog diff --git a/docs/source/generated/src.shiver.views.corrections.rst b/docs/source/generated/src.shiver.views.corrections.rst new file mode 100644 index 00000000..e2e46465 --- /dev/null +++ b/docs/source/generated/src.shiver.views.corrections.rst @@ -0,0 +1,20 @@ +src.shiver.views.corrections +============================ + +.. automodule:: src.shiver.views.corrections + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Corrections diff --git a/docs/source/generated/src.shiver.views.data.rst b/docs/source/generated/src.shiver.views.data.rst new file mode 100644 index 00000000..e1f8ccce --- /dev/null +++ b/docs/source/generated/src.shiver.views.data.rst @@ -0,0 +1,26 @@ +src.shiver.views.data +===================== + +.. automodule:: src.shiver.views.data + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + filename_str_to_list + + + + + + .. rubric:: Classes + + .. autosummary:: + + RawData diff --git a/docs/source/generated/src.shiver.views.generate.rst b/docs/source/generated/src.shiver.views.generate.rst new file mode 100644 index 00000000..ef9719c4 --- /dev/null +++ b/docs/source/generated/src.shiver.views.generate.rst @@ -0,0 +1,29 @@ +src.shiver.views.generate +========================= + +.. automodule:: src.shiver.views.generate + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + has_special_char + is_valid_name + + + + + + .. rubric:: Classes + + .. autosummary:: + + Buttons + Generate + MDEType diff --git a/docs/source/generated/src.shiver.views.histogram.rst b/docs/source/generated/src.shiver.views.histogram.rst new file mode 100644 index 00000000..5f9fba79 --- /dev/null +++ b/docs/source/generated/src.shiver.views.histogram.rst @@ -0,0 +1,20 @@ +src.shiver.views.histogram +========================== + +.. automodule:: src.shiver.views.histogram + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + Histogram diff --git a/docs/source/generated/src.shiver.views.histogram_parameters.rst b/docs/source/generated/src.shiver.views.histogram_parameters.rst new file mode 100644 index 00000000..1a991e18 --- /dev/null +++ b/docs/source/generated/src.shiver.views.histogram_parameters.rst @@ -0,0 +1,29 @@ +src.shiver.views.histogram\_parameters +====================================== + +.. automodule:: src.shiver.views.histogram_parameters + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + return_valid + translation + + + + + + .. rubric:: Classes + + .. autosummary:: + + Dimensions + HistogramParameter + V3DValidator diff --git a/docs/source/generated/src.shiver.views.invalid_styles.rst b/docs/source/generated/src.shiver.views.invalid_styles.rst new file mode 100644 index 00000000..35e66aa1 --- /dev/null +++ b/docs/source/generated/src.shiver.views.invalid_styles.rst @@ -0,0 +1,4 @@ +src.shiver.views.invalid\_styles +================================ + +.. automodule:: src.shiver.views.invalid_styles diff --git a/docs/source/generated/src.shiver.views.loading_buttons.rst b/docs/source/generated/src.shiver.views.loading_buttons.rst new file mode 100644 index 00000000..2d40b2fd --- /dev/null +++ b/docs/source/generated/src.shiver.views.loading_buttons.rst @@ -0,0 +1,20 @@ +src.shiver.views.loading\_buttons +================================= + +.. automodule:: src.shiver.views.loading_buttons + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + LoadingButtons diff --git a/docs/source/generated/src.shiver.views.mainwindow.rst b/docs/source/generated/src.shiver.views.mainwindow.rst new file mode 100644 index 00000000..9a076400 --- /dev/null +++ b/docs/source/generated/src.shiver.views.mainwindow.rst @@ -0,0 +1,20 @@ +src.shiver.views.mainwindow +=========================== + +.. automodule:: src.shiver.views.mainwindow + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + MainWindow diff --git a/docs/source/generated/src.shiver.views.oncat.rst b/docs/source/generated/src.shiver.views.oncat.rst new file mode 100644 index 00000000..568cab2c --- /dev/null +++ b/docs/source/generated/src.shiver.views.oncat.rst @@ -0,0 +1,31 @@ +src.shiver.views.oncat +====================== + +.. automodule:: src.shiver.views.oncat + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + get_data_from_oncat + get_dataset_info + get_dataset_names + + + + + + .. rubric:: Classes + + .. autosummary:: + + OnCatAgent + OnCatLogin + Oncat + OncatToken diff --git a/docs/source/generated/src.shiver.views.plots.rst b/docs/source/generated/src.shiver.views.plots.rst new file mode 100644 index 00000000..0d0150aa --- /dev/null +++ b/docs/source/generated/src.shiver.views.plots.rst @@ -0,0 +1,16 @@ +src.shiver.views.plots +====================== + +.. automodule:: src.shiver.views.plots + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + do_default_plot diff --git a/docs/source/generated/src.shiver.views.polarized_options.rst b/docs/source/generated/src.shiver.views.polarized_options.rst new file mode 100644 index 00000000..6f74818d --- /dev/null +++ b/docs/source/generated/src.shiver.views.polarized_options.rst @@ -0,0 +1,27 @@ +src.shiver.views.polarized\_options +=================================== + +.. automodule:: src.shiver.views.polarized_options + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + return_valid + + + + + + .. rubric:: Classes + + .. autosummary:: + + PolarizedDialog + RatioValidator diff --git a/docs/source/generated/src.shiver.views.reduction_parameters.rst b/docs/source/generated/src.shiver.views.reduction_parameters.rst new file mode 100644 index 00000000..33f5a527 --- /dev/null +++ b/docs/source/generated/src.shiver.views.reduction_parameters.rst @@ -0,0 +1,20 @@ +src.shiver.views.reduction\_parameters +====================================== + +.. automodule:: src.shiver.views.reduction_parameters + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + ReductionParameters diff --git a/docs/source/generated/src.shiver.views.sample.rst b/docs/source/generated/src.shiver.views.sample.rst new file mode 100644 index 00000000..48ca3c6a --- /dev/null +++ b/docs/source/generated/src.shiver.views.sample.rst @@ -0,0 +1,22 @@ +src.shiver.views.sample +======================= + +.. automodule:: src.shiver.views.sample + + + + + + + + + + + + .. rubric:: Classes + + .. autosummary:: + + LatticeParametersWidget + SampleDialog + SampleView diff --git a/docs/source/generated/src.shiver.views.workspace_tables.rst b/docs/source/generated/src.shiver.views.workspace_tables.rst new file mode 100644 index 00000000..1fede581 --- /dev/null +++ b/docs/source/generated/src.shiver.views.workspace_tables.rst @@ -0,0 +1,33 @@ +src.shiver.views.workspace\_tables +================================== + +.. automodule:: src.shiver.views.workspace_tables + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + get_icon + + + + + + .. rubric:: Classes + + .. autosummary:: + + ADSList + Frame + HistogramWorkspaces + IconLegend + InputWorkspaces + MDEList + MDHList + NormList diff --git a/docs/source/generated/tests.conftest.rst b/docs/source/generated/tests.conftest.rst new file mode 100644 index 00000000..3b875ef7 --- /dev/null +++ b/docs/source/generated/tests.conftest.rst @@ -0,0 +1,17 @@ +tests.conftest +============== + +.. automodule:: tests.conftest + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + clear_ads + shiver_app diff --git a/docs/source/generated/tests.data.define_data.rst b/docs/source/generated/tests.data.define_data.rst new file mode 100644 index 00000000..5e1c04b3 --- /dev/null +++ b/docs/source/generated/tests.data.define_data.rst @@ -0,0 +1,16 @@ +tests.data.define\_data +======================= + +.. automodule:: tests.data.define_data + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + define_data_set diff --git a/docs/source/generated/tests.models.test_gather_history.rst b/docs/source/generated/tests.models.test_gather_history.rst new file mode 100644 index 00000000..de535e69 --- /dev/null +++ b/docs/source/generated/tests.models.test_gather_history.rst @@ -0,0 +1,16 @@ +tests.models.test\_gather\_history +================================== + +.. automodule:: tests.models.test_gather_history + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_get_make_slice_history diff --git a/docs/source/generated/tests.models.test_generate_model.rst b/docs/source/generated/tests.models.test_generate_model.rst new file mode 100644 index 00000000..ad599cbd --- /dev/null +++ b/docs/source/generated/tests.models.test_generate_model.rst @@ -0,0 +1,17 @@ +tests.models.test\_generate\_model +================================== + +.. automodule:: tests.models.test_generate_model + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_gather_mde_config_dict + test_generate_mde_model diff --git a/docs/source/generated/tests.models.test_generatemde.rst b/docs/source/generated/tests.models.test_generatemde.rst new file mode 100644 index 00000000..0006317e --- /dev/null +++ b/docs/source/generated/tests.models.test_generatemde.rst @@ -0,0 +1,24 @@ +tests.models.test\_generatemde +============================== + +.. automodule:: tests.models.test_generatemde + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_convert_dgs_to_single_mde_additional_dims + test_convert_dgs_to_single_mde_calculate_t0_ei + test_convert_dgs_to_single_mde_mask + test_convert_dgs_to_single_mde_merged + test_convert_dgs_to_single_mde_single_qlab + test_convert_dgs_to_single_mde_single_qsample + test_generate_dgs_mde + test_generate_dgs_mde_bkg + test_generate_dgs_mde_seq diff --git a/docs/source/generated/tests.models.test_histogram_saving.rst b/docs/source/generated/tests.models.test_histogram_saving.rst new file mode 100644 index 00000000..338355ef --- /dev/null +++ b/docs/source/generated/tests.models.test_histogram_saving.rst @@ -0,0 +1,16 @@ +tests.models.test\_histogram\_saving +==================================== + +.. automodule:: tests.models.test_histogram_saving + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_saving diff --git a/docs/source/generated/tests.models.test_load.rst b/docs/source/generated/tests.models.test_load.rst new file mode 100644 index 00000000..22feef3e --- /dev/null +++ b/docs/source/generated/tests.models.test_load.rst @@ -0,0 +1,20 @@ +tests.models.test\_load +======================= + +.. automodule:: tests.models.test_load + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_bad_file + test_load_dataset + test_load_mde + test_load_norm + test_nonexisted_file diff --git a/docs/source/generated/tests.models.test_makeslice.rst b/docs/source/generated/tests.models.test_makeslice.rst new file mode 100644 index 00000000..337be3b2 --- /dev/null +++ b/docs/source/generated/tests.models.test_makeslice.rst @@ -0,0 +1,18 @@ +tests.models.test\_makeslice +============================ + +.. automodule:: tests.models.test_makeslice + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_2d_slice + test_make_slice_1d + test_make_slice_1d_inelastic diff --git a/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst b/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst new file mode 100644 index 00000000..7cf15572 --- /dev/null +++ b/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst @@ -0,0 +1,20 @@ +tests.models.test\_sample\_parameters\_buttons\_actions +======================================================= + +.. automodule:: tests.models.test_sample_parameters_buttons_actions + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_apply_button_invalid + test_apply_button_valid + test_isaw_button_invalid + test_nexus_button_invalid + test_procesed_nexus_button_invalid diff --git a/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst b/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst new file mode 100644 index 00000000..53bc5fa0 --- /dev/null +++ b/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst @@ -0,0 +1,19 @@ +tests.models.test\_sample\_parameters\_invalid\_inputs +====================================================== + +.. automodule:: tests.models.test_sample_parameters_invalid_inputs + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_colinear_u_v + test_invalid_angles + test_invalid_matrix + test_invalid_workspace diff --git a/docs/source/generated/tests.models.test_save.rst b/docs/source/generated/tests.models.test_save.rst new file mode 100644 index 00000000..9d4dc231 --- /dev/null +++ b/docs/source/generated/tests.models.test_save.rst @@ -0,0 +1,16 @@ +tests.models.test\_save +======================= + +.. automodule:: tests.models.test_save + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_save_to_ascii diff --git a/docs/source/generated/tests.models.test_symmetry_operations.rst b/docs/source/generated/tests.models.test_symmetry_operations.rst new file mode 100644 index 00000000..016be42a --- /dev/null +++ b/docs/source/generated/tests.models.test_symmetry_operations.rst @@ -0,0 +1,20 @@ +tests.models.test\_symmetry\_operations +======================================= + +.. automodule:: tests.models.test_symmetry_operations + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_symmetry_invalid + test_symmetry_valid_char_array + test_symmetry_valid_spacegroup + test_symmetry_valid_spacegroup_num + test_symmetry_valid_spacegroup_sym diff --git a/docs/source/generated/tests.models.test_utils.rst b/docs/source/generated/tests.models.test_utils.rst new file mode 100644 index 00000000..cbf045c7 --- /dev/null +++ b/docs/source/generated/tests.models.test_utils.rst @@ -0,0 +1,16 @@ +tests.models.test\_utils +======================== + +.. automodule:: tests.models.test_utils + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_flatten_list diff --git a/docs/source/generated/tests.views.test_correction.rst b/docs/source/generated/tests.views.test_correction.rst new file mode 100644 index 00000000..b055c66c --- /dev/null +++ b/docs/source/generated/tests.views.test_correction.rst @@ -0,0 +1,16 @@ +tests.views.test\_correction +============================ + +.. automodule:: tests.views.test_correction + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_corrections_table diff --git a/docs/source/generated/tests.views.test_dimensions.rst b/docs/source/generated/tests.views.test_dimensions.rst new file mode 100644 index 00000000..d39e3676 --- /dev/null +++ b/docs/source/generated/tests.views.test_dimensions.rst @@ -0,0 +1,23 @@ +tests.views.test\_dimensions +============================ + +.. automodule:: tests.views.test_dimensions + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_dimensions_dropdown_uniqueness + test_dimensions_min_max_color_invalid + test_dimensions_min_max_color_missing + test_dimensions_min_max_valid + test_dimensions_radio_btn + test_dimensions_ste_values_required_color + test_dimensions_step_values_invalid + test_dimensions_update_on_projection_edit diff --git a/docs/source/generated/tests.views.test_generate.rst b/docs/source/generated/tests.views.test_generate.rst new file mode 100644 index 00000000..75c64f96 --- /dev/null +++ b/docs/source/generated/tests.views.test_generate.rst @@ -0,0 +1,20 @@ +tests.views.test\_generate +========================== + +.. automodule:: tests.views.test_generate + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_generate_widget_colors_invalid + test_generate_widget_colors_valid + test_mde_name_check + test_mde_type_widget + test_path_check diff --git a/docs/source/generated/tests.views.test_histogram.rst b/docs/source/generated/tests.views.test_histogram.rst new file mode 100644 index 00000000..a1854ba5 --- /dev/null +++ b/docs/source/generated/tests.views.test_histogram.rst @@ -0,0 +1,21 @@ +tests.views.test\_histogram +=========================== + +.. automodule:: tests.views.test_histogram + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_histogram + test_load_dataset_presenter + test_make_histogram_button + test_msg_dialog + test_norm_workspaces_menu + test_populate_ui_from_history_dict diff --git a/docs/source/generated/tests.views.test_histogram_button.rst b/docs/source/generated/tests.views.test_histogram_button.rst new file mode 100644 index 00000000..767d5ffb --- /dev/null +++ b/docs/source/generated/tests.views.test_histogram_button.rst @@ -0,0 +1,17 @@ +tests.views.test\_histogram\_button +=================================== + +.. automodule:: tests.views.test_histogram_button + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_dictionary_creation_histogram_btn + test_update_plot_num diff --git a/docs/source/generated/tests.views.test_loading_buttons.rst b/docs/source/generated/tests.views.test_loading_buttons.rst new file mode 100644 index 00000000..6c2aa67d --- /dev/null +++ b/docs/source/generated/tests.views.test_loading_buttons.rst @@ -0,0 +1,17 @@ +tests.views.test\_loading\_buttons +================================== + +.. automodule:: tests.views.test_loading_buttons + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_file_loading + test_load_dataset_button diff --git a/docs/source/generated/tests.views.test_mainwindow.rst b/docs/source/generated/tests.views.test_mainwindow.rst new file mode 100644 index 00000000..757ff28e --- /dev/null +++ b/docs/source/generated/tests.views.test_mainwindow.rst @@ -0,0 +1,16 @@ +tests.views.test\_mainwindow +============================ + +.. automodule:: tests.views.test_mainwindow + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_mainwindow diff --git a/docs/source/generated/tests.views.test_mde_workspaces.rst b/docs/source/generated/tests.views.test_mde_workspaces.rst new file mode 100644 index 00000000..6aacd7f2 --- /dev/null +++ b/docs/source/generated/tests.views.test_mde_workspaces.rst @@ -0,0 +1,17 @@ +tests.views.test\_mde\_workspaces +================================= + +.. automodule:: tests.views.test_mde_workspaces + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_mde_workspaces_icon + test_mde_workspaces_menu diff --git a/docs/source/generated/tests.views.test_mdh_workspaces.rst b/docs/source/generated/tests.views.test_mdh_workspaces.rst new file mode 100644 index 00000000..e3b7bbde --- /dev/null +++ b/docs/source/generated/tests.views.test_mdh_workspaces.rst @@ -0,0 +1,20 @@ +tests.views.test\_mdh\_workspaces +================================= + +.. automodule:: tests.views.test_mdh_workspaces + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + handle_menu + test_mdh_plotting_1d + test_mdh_plotting_2d + test_mdh_plotting_3d + test_mdh_workspaces_menu diff --git a/docs/source/generated/tests.views.test_oncat.rst b/docs/source/generated/tests.views.test_oncat.rst new file mode 100644 index 00000000..40a29b83 --- /dev/null +++ b/docs/source/generated/tests.views.test_oncat.rst @@ -0,0 +1,33 @@ +tests.views.test\_oncat +======================= + +.. automodule:: tests.views.test_oncat + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_get_data_from_oncat + test_get_dataset_info + test_get_dataset_names + test_oncat + test_oncat_agent + test_oncat_login + test_oncat_token + + + + + + .. rubric:: Classes + + .. autosummary:: + + MockONcat + MockRecord diff --git a/docs/source/generated/tests.views.test_polarized_options.rst b/docs/source/generated/tests.views.test_polarized_options.rst new file mode 100644 index 00000000..37d4333b --- /dev/null +++ b/docs/source/generated/tests.views.test_polarized_options.rst @@ -0,0 +1,28 @@ +tests.views.test\_polarized\_options +==================================== + +.. automodule:: tests.views.test_polarized_options + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_apply_btn_invalid + test_apply_btn_valid + test_apply_btn_valid_all + test_help_button + test_polarized_options_initialization_from_dict_invalid + test_polarized_options_initialization_from_dict_nsf + test_polarized_options_initialization_from_dict_unpolarized + test_polarized_options_invalid_psda + test_polarized_options_invalid_ratio_log + test_polarized_options_no_spin + test_polarized_options_ratio_num + test_polarized_options_spin + test_polarized_options_unpolarized diff --git a/docs/source/generated/tests.views.test_projections.rst b/docs/source/generated/tests.views.test_projections.rst new file mode 100644 index 00000000..aa9b5a5f --- /dev/null +++ b/docs/source/generated/tests.views.test_projections.rst @@ -0,0 +1,18 @@ +tests.views.test\_projections +============================= + +.. automodule:: tests.views.test_projections + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_projections_co_linear_color + test_projections_invalid_color + test_projections_valid_values diff --git a/docs/source/generated/tests.views.test_raw_data.rst b/docs/source/generated/tests.views.test_raw_data.rst new file mode 100644 index 00000000..079ed389 --- /dev/null +++ b/docs/source/generated/tests.views.test_raw_data.rst @@ -0,0 +1,20 @@ +tests.views.test\_raw\_data +=========================== + +.. automodule:: tests.views.test_raw_data + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_filename_str_to_list + test_populate_data_widget_from_dict + test_raw_data_editing_path + test_raw_data_get_selection + test_raw_data_set_selection diff --git a/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst b/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst new file mode 100644 index 00000000..9cd32698 --- /dev/null +++ b/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst @@ -0,0 +1,23 @@ +tests.views.test\_reduction\_parameters\_inputs +=============================================== + +.. automodule:: tests.views.test_reduction_parameters_inputs + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_reduction_parameters_get_data_first_level + test_reduction_parameters_initialization_from_dict_reduct + test_reduction_parameters_initialization_from_dict_to_dict + test_reduction_parameters_mask_valid_input + test_reduction_parameters_norm_valid_input + test_reduction_parameters_text_invalid_input + test_reduction_parameters_text_invalid_numbers + test_reduction_parameters_text_valid_input diff --git a/docs/source/generated/tests.views.test_sample_parameters_buttons.rst b/docs/source/generated/tests.views.test_sample_parameters_buttons.rst new file mode 100644 index 00000000..04a9a62a --- /dev/null +++ b/docs/source/generated/tests.views.test_sample_parameters_buttons.rst @@ -0,0 +1,22 @@ +tests.views.test\_sample\_parameters\_buttons +============================================= + +.. automodule:: tests.views.test_sample_parameters_buttons + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_get_data_sample_after_apply + test_help_button + test_isaw_button + test_load_processed_button + test_nexus_button + test_sample_parameters_updates_and_load_button + test_sample_parameters_updates_invalid_and_load_button diff --git a/docs/source/generated/tests.views.test_sample_parameters_inputs.rst b/docs/source/generated/tests.views.test_sample_parameters_inputs.rst new file mode 100644 index 00000000..196422d3 --- /dev/null +++ b/docs/source/generated/tests.views.test_sample_parameters_inputs.rst @@ -0,0 +1,24 @@ +tests.views.test\_sample\_parameters\_inputs +============================================ + +.. automodule:: tests.views.test_sample_parameters_inputs + + + + + + + + .. rubric:: Functions + + .. autosummary:: + + test_lattice_parameters_invalid_input + test_lattice_parameters_valid_input + test_sample_parameters_initialization + test_sample_parameters_initialization_from_dict + test_sample_parameters_initialization_from_dict_invalid + test_sample_parameters_initialization_no_workspace + test_sample_parameters_updates + test_ub_matrix_invalid_input + test_ub_matrix_valid_input diff --git a/docs/source/index.rst b/docs/source/index.rst index 96b939d1..dedd8c51 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -31,6 +31,5 @@ Contents getting_started usage - api + repo_doc deploy - reading_materials diff --git a/docs/source/reading_materials.rst b/docs/source/reading_materials.rst deleted file mode 100644 index 4b244216..00000000 --- a/docs/source/reading_materials.rst +++ /dev/null @@ -1,29 +0,0 @@ -Additional Reading Materials -============================ - -.. _reading_materials: - -Suggested Reading Material --------------------------- - -Physics: Conservation of Energy & Momentum - -Math - Geometry/Trigonometry: - -* Coordinate system - -* Pythongorean theorem generalization/ Law of Cosines - -* Scalar and Vector products - -* `Euclidean vector concepts `_ - -Neutrons Scattering ORNL `(Slides) `_ - -Neutron and X-Ray Spectroscopy `(Book) `_ - -Research Papers: - -* Efficient Data Management in Neutron Scattering Data Reduction Workflows at ORNL `(paper) `_ - -* Efficient Data Reduction for Time-of-Flight Neutron Scattering Experiments on Single Crystals `(paper) `_ diff --git a/docs/source/repo_doc.rst b/docs/source/repo_doc.rst new file mode 100644 index 00000000..a8621c76 --- /dev/null +++ b/docs/source/repo_doc.rst @@ -0,0 +1,74 @@ +Repository Documentation +======================== + +.. autosummary:: + :toctree: generated + + src.shiver.version + src.shiver.shiver + src.shiver.models.sample + src.shiver.models.help + src.shiver.models.generate + src.shiver.models.convert_dgs_to_single_mde + src.shiver.models.makeslice + src.shiver.models.generate_dgs_mde + src.shiver.models.corrections + src.shiver.models.utils + src.shiver.models.histogram + src.shiver.presenters.sample + src.shiver.presenters.generate + src.shiver.presenters.histogram + src.shiver.views.histogram_parameters + src.shiver.views.sample + src.shiver.views.invalid_styles + src.shiver.views.oncat + src.shiver.views.generate + src.shiver.views.advanced_options + src.shiver.views.data + src.shiver.views.loading_buttons + src.shiver.views.workspace_tables + src.shiver.views.plots + src.shiver.views.mainwindow + src.shiver.views.reduction_parameters + src.shiver.views.corrections + src.shiver.views.polarized_options + src.shiver.views.histogram + tests.conftest + tests.models.test_generate_model + tests.models.test_sample_parameters_invalid_inputs + tests.models.test_sample_parameters_buttons_actions + tests.models.test_generatemde + tests.models.test_symmetry_operations + tests.models.test_makeslice + tests.models.test_save + tests.models.test_utils + tests.models.test_gather_history + tests.models.test_load + tests.models.test_histogram_saving + tests.data.define_data + tests.views.test_dimensions + tests.views.test_polarized_options + tests.views.test_oncat + tests.views.test_raw_data + tests.views.test_projections + tests.views.test_loading_buttons + tests.views.test_sample_parameters_inputs + tests.views.test_generate + tests.views.test_correction + tests.views.test_sample_parameters_buttons + tests.views.test_mdh_workspaces + tests.views.test_histogram + tests.views.test_mainwindow + tests.views.test_histogram_button + tests.views.test_mde_workspaces + tests.views.test_reduction_parameters_inputs + DGS_SC_scripts.slice_utils + DGS_SC_scripts.define_slices_example_polarized + DGS_SC_scripts.reduce_data_to_MDE + DGS_SC_scripts.slice_maker_example1 + DGS_SC_scripts.slice_maker_example_polarized + DGS_SC_scripts.define_data_example_polarized + DGS_SC_scripts.define_slices_example1 + DGS_SC_scripts.oncat_example + DGS_SC_scripts.define_data_example1 + DGS_SC_scripts.oncat_util From 1b12953fdb08323751b0109683db1f0db3beec0a Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 14:02:11 -0400 Subject: [PATCH 03/13] Removing this empty file. --- docs/source/generated/src.shiver._version.rst | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 docs/source/generated/src.shiver._version.rst diff --git a/docs/source/generated/src.shiver._version.rst b/docs/source/generated/src.shiver._version.rst deleted file mode 100644 index 0473e6be..00000000 --- a/docs/source/generated/src.shiver._version.rst +++ /dev/null @@ -1,4 +0,0 @@ -src.shiver.\_version -==================== - -.. automodule:: src.shiver._version From 7c0a9fa303caba3c74d6beb8cc9b75c00ce7bddc Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 14:07:44 -0400 Subject: [PATCH 04/13] Had to bypass conf.py from pre-commit because ALL CAP labels for the variables within this file messes up the formatting within the generated documentation. --- docs/source/conf.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index b1449397..51af3d62 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,11 +17,11 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -PROJECT = "SHIVER" -COPYRIGHT = "2022, ORNL" -AUTHOR = "ORNL" -VERSION = versioningit.get_version("../../") -RELEASE = ".".join(VERSION.split(".")[:-1]) +project = "SHIVER" +copyright = "2022, ORNL" +author = "ORNL" +version = versioningit.get_version("../../") +release = ".".join(version.split(".")[:-1]) # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -47,8 +47,8 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -HTML_THEME = "sphinx_rtd_theme" +html_theme = "sphinx_rtd_theme" html_theme_options = {"style_nav_header_background": "#472375"} -EPUB_SHOW_URLS = "footnote" +epub_show_urls = "footnote" From 9e47810ac9647d32b5b9c8afd3e7646ea223726f Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 14:57:52 -0400 Subject: [PATCH 05/13] Fixed documentation to use .. automodule:: instead of .. autodoc::. This give more comprehensive overview. --- .../DGS_SC_scripts.define_data_example1.rst | 16 -- ..._scripts.define_data_example_polarized.rst | 16 -- .../DGS_SC_scripts.define_slices_example1.rst | 16 -- ...cripts.define_slices_example_polarized.rst | 16 -- .../generated/DGS_SC_scripts.oncat_util.rst | 20 --- .../DGS_SC_scripts.reduce_data_to_MDE.rst | 20 --- .../generated/DGS_SC_scripts.slice_utils.rst | 26 --- ...hiver.models.convert_dgs_to_single_mde.rst | 20 --- .../src.shiver.models.corrections.rst | 22 --- .../generated/src.shiver.models.generate.rst | 28 --- .../src.shiver.models.generate_dgs_mde.rst | 20 --- .../generated/src.shiver.models.help.rst | 16 -- .../generated/src.shiver.models.histogram.rst | 32 ---- .../generated/src.shiver.models.makeslice.rst | 20 --- .../generated/src.shiver.models.sample.rst | 20 --- .../generated/src.shiver.models.utils.rst | 16 -- .../src.shiver.presenters.generate.rst | 26 --- .../src.shiver.presenters.histogram.rst | 20 --- .../src.shiver.presenters.sample.rst | 20 --- docs/source/generated/src.shiver.shiver.rst | 20 --- docs/source/generated/src.shiver.version.rst | 4 - .../src.shiver.views.advanced_options.rst | 27 --- .../src.shiver.views.corrections.rst | 20 --- .../generated/src.shiver.views.data.rst | 26 --- .../generated/src.shiver.views.generate.rst | 29 --- .../generated/src.shiver.views.histogram.rst | 20 --- .../src.shiver.views.histogram_parameters.rst | 29 --- .../src.shiver.views.invalid_styles.rst | 4 - .../src.shiver.views.loading_buttons.rst | 20 --- .../generated/src.shiver.views.mainwindow.rst | 20 --- .../generated/src.shiver.views.oncat.rst | 31 ---- .../generated/src.shiver.views.plots.rst | 16 -- .../src.shiver.views.polarized_options.rst | 27 --- .../src.shiver.views.reduction_parameters.rst | 20 --- .../generated/src.shiver.views.sample.rst | 22 --- .../src.shiver.views.workspace_tables.rst | 33 ---- docs/source/generated/tests.conftest.rst | 17 -- .../generated/tests.data.define_data.rst | 16 -- .../tests.models.test_gather_history.rst | 16 -- .../tests.models.test_generate_model.rst | 17 -- .../tests.models.test_generatemde.rst | 24 --- .../tests.models.test_histogram_saving.rst | 16 -- .../generated/tests.models.test_load.rst | 20 --- .../generated/tests.models.test_makeslice.rst | 18 -- ...test_sample_parameters_buttons_actions.rst | 20 --- ....test_sample_parameters_invalid_inputs.rst | 19 -- .../generated/tests.models.test_save.rst | 16 -- .../tests.models.test_symmetry_operations.rst | 20 --- .../generated/tests.models.test_utils.rst | 16 -- .../generated/tests.views.test_correction.rst | 16 -- .../generated/tests.views.test_dimensions.rst | 23 --- .../generated/tests.views.test_generate.rst | 20 --- .../generated/tests.views.test_histogram.rst | 21 --- .../tests.views.test_histogram_button.rst | 17 -- .../tests.views.test_loading_buttons.rst | 17 -- .../generated/tests.views.test_mainwindow.rst | 16 -- .../tests.views.test_mde_workspaces.rst | 17 -- .../tests.views.test_mdh_workspaces.rst | 20 --- .../generated/tests.views.test_oncat.rst | 33 ---- .../tests.views.test_polarized_options.rst | 28 --- .../tests.views.test_projections.rst | 18 -- .../generated/tests.views.test_raw_data.rst | 20 --- ...views.test_reduction_parameters_inputs.rst | 23 --- ...s.views.test_sample_parameters_buttons.rst | 22 --- ...ts.views.test_sample_parameters_inputs.rst | 24 --- docs/source/index.rst | 1 + docs/source/repo_doc.rst | 165 ++++++++++-------- src/shiver/views/oncat.py | 2 +- 68 files changed, 96 insertions(+), 1400 deletions(-) delete mode 100644 docs/source/generated/DGS_SC_scripts.define_data_example1.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.define_slices_example1.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.oncat_util.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst delete mode 100644 docs/source/generated/DGS_SC_scripts.slice_utils.rst delete mode 100644 docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst delete mode 100644 docs/source/generated/src.shiver.models.corrections.rst delete mode 100644 docs/source/generated/src.shiver.models.generate.rst delete mode 100644 docs/source/generated/src.shiver.models.generate_dgs_mde.rst delete mode 100644 docs/source/generated/src.shiver.models.help.rst delete mode 100644 docs/source/generated/src.shiver.models.histogram.rst delete mode 100644 docs/source/generated/src.shiver.models.makeslice.rst delete mode 100644 docs/source/generated/src.shiver.models.sample.rst delete mode 100644 docs/source/generated/src.shiver.models.utils.rst delete mode 100644 docs/source/generated/src.shiver.presenters.generate.rst delete mode 100644 docs/source/generated/src.shiver.presenters.histogram.rst delete mode 100644 docs/source/generated/src.shiver.presenters.sample.rst delete mode 100644 docs/source/generated/src.shiver.shiver.rst delete mode 100644 docs/source/generated/src.shiver.version.rst delete mode 100644 docs/source/generated/src.shiver.views.advanced_options.rst delete mode 100644 docs/source/generated/src.shiver.views.corrections.rst delete mode 100644 docs/source/generated/src.shiver.views.data.rst delete mode 100644 docs/source/generated/src.shiver.views.generate.rst delete mode 100644 docs/source/generated/src.shiver.views.histogram.rst delete mode 100644 docs/source/generated/src.shiver.views.histogram_parameters.rst delete mode 100644 docs/source/generated/src.shiver.views.invalid_styles.rst delete mode 100644 docs/source/generated/src.shiver.views.loading_buttons.rst delete mode 100644 docs/source/generated/src.shiver.views.mainwindow.rst delete mode 100644 docs/source/generated/src.shiver.views.oncat.rst delete mode 100644 docs/source/generated/src.shiver.views.plots.rst delete mode 100644 docs/source/generated/src.shiver.views.polarized_options.rst delete mode 100644 docs/source/generated/src.shiver.views.reduction_parameters.rst delete mode 100644 docs/source/generated/src.shiver.views.sample.rst delete mode 100644 docs/source/generated/src.shiver.views.workspace_tables.rst delete mode 100644 docs/source/generated/tests.conftest.rst delete mode 100644 docs/source/generated/tests.data.define_data.rst delete mode 100644 docs/source/generated/tests.models.test_gather_history.rst delete mode 100644 docs/source/generated/tests.models.test_generate_model.rst delete mode 100644 docs/source/generated/tests.models.test_generatemde.rst delete mode 100644 docs/source/generated/tests.models.test_histogram_saving.rst delete mode 100644 docs/source/generated/tests.models.test_load.rst delete mode 100644 docs/source/generated/tests.models.test_makeslice.rst delete mode 100644 docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst delete mode 100644 docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst delete mode 100644 docs/source/generated/tests.models.test_save.rst delete mode 100644 docs/source/generated/tests.models.test_symmetry_operations.rst delete mode 100644 docs/source/generated/tests.models.test_utils.rst delete mode 100644 docs/source/generated/tests.views.test_correction.rst delete mode 100644 docs/source/generated/tests.views.test_dimensions.rst delete mode 100644 docs/source/generated/tests.views.test_generate.rst delete mode 100644 docs/source/generated/tests.views.test_histogram.rst delete mode 100644 docs/source/generated/tests.views.test_histogram_button.rst delete mode 100644 docs/source/generated/tests.views.test_loading_buttons.rst delete mode 100644 docs/source/generated/tests.views.test_mainwindow.rst delete mode 100644 docs/source/generated/tests.views.test_mde_workspaces.rst delete mode 100644 docs/source/generated/tests.views.test_mdh_workspaces.rst delete mode 100644 docs/source/generated/tests.views.test_oncat.rst delete mode 100644 docs/source/generated/tests.views.test_polarized_options.rst delete mode 100644 docs/source/generated/tests.views.test_projections.rst delete mode 100644 docs/source/generated/tests.views.test_raw_data.rst delete mode 100644 docs/source/generated/tests.views.test_reduction_parameters_inputs.rst delete mode 100644 docs/source/generated/tests.views.test_sample_parameters_buttons.rst delete mode 100644 docs/source/generated/tests.views.test_sample_parameters_inputs.rst diff --git a/docs/source/generated/DGS_SC_scripts.define_data_example1.rst b/docs/source/generated/DGS_SC_scripts.define_data_example1.rst deleted file mode 100644 index efdb5946..00000000 --- a/docs/source/generated/DGS_SC_scripts.define_data_example1.rst +++ /dev/null @@ -1,16 +0,0 @@ -DGS\_SC\_scripts.define\_data\_example1 -======================================= - -.. automodule:: DGS_SC_scripts.define_data_example1 - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - define_data_set diff --git a/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst b/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst deleted file mode 100644 index ec830f03..00000000 --- a/docs/source/generated/DGS_SC_scripts.define_data_example_polarized.rst +++ /dev/null @@ -1,16 +0,0 @@ -DGS\_SC\_scripts.define\_data\_example\_polarized -================================================= - -.. automodule:: DGS_SC_scripts.define_data_example_polarized - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - define_data_set diff --git a/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst b/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst deleted file mode 100644 index 03612029..00000000 --- a/docs/source/generated/DGS_SC_scripts.define_slices_example1.rst +++ /dev/null @@ -1,16 +0,0 @@ -DGS\_SC\_scripts.define\_slices\_example1 -========================================= - -.. automodule:: DGS_SC_scripts.define_slices_example1 - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - define_data_slices diff --git a/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst b/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst deleted file mode 100644 index fb2a20c0..00000000 --- a/docs/source/generated/DGS_SC_scripts.define_slices_example_polarized.rst +++ /dev/null @@ -1,16 +0,0 @@ -DGS\_SC\_scripts.define\_slices\_example\_polarized -=================================================== - -.. automodule:: DGS_SC_scripts.define_slices_example_polarized - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - define_data_slices diff --git a/docs/source/generated/DGS_SC_scripts.oncat_util.rst b/docs/source/generated/DGS_SC_scripts.oncat_util.rst deleted file mode 100644 index 2035e18c..00000000 --- a/docs/source/generated/DGS_SC_scripts.oncat_util.rst +++ /dev/null @@ -1,20 +0,0 @@ -DGS\_SC\_scripts.oncat\_util -============================ - -.. automodule:: DGS_SC_scripts.oncat_util - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - get_data_from_oncat - get_dataset_info - get_dataset_names - oncat_login - write_json_from_oncat diff --git a/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst b/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst deleted file mode 100644 index 2a84ddef..00000000 --- a/docs/source/generated/DGS_SC_scripts.reduce_data_to_MDE.rst +++ /dev/null @@ -1,20 +0,0 @@ -DGS\_SC\_scripts.reduce\_data\_to\_MDE -====================================== - -.. automodule:: DGS_SC_scripts.reduce_data_to_MDE - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - detector_geometry_correction - generate_BG_mde - generate_mde - polarizer_transmission - reduce_data_to_MDE diff --git a/docs/source/generated/DGS_SC_scripts.slice_utils.rst b/docs/source/generated/DGS_SC_scripts.slice_utils.rst deleted file mode 100644 index cd42e837..00000000 --- a/docs/source/generated/DGS_SC_scripts.slice_utils.rst +++ /dev/null @@ -1,26 +0,0 @@ -DGS\_SC\_scripts.slice\_utils -============================= - -.. automodule:: DGS_SC_scripts.slice_utils - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - SaveMDToAscii - dim2array - filter_large_error - gauss - make_slice - make_slices_FR_corrected - plot_slice - plot_w_parameters - set_axes_parameters - slice_des2str - subtract_incoherent diff --git a/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst b/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst deleted file mode 100644 index b95521e3..00000000 --- a/docs/source/generated/src.shiver.models.convert_dgs_to_single_mde.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.models.convert\_dgs\_to\_single\_mde -=============================================== - -.. automodule:: src.shiver.models.convert_dgs_to_single_mde - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ConvertDGSToSingleMDE diff --git a/docs/source/generated/src.shiver.models.corrections.rst b/docs/source/generated/src.shiver.models.corrections.rst deleted file mode 100644 index 2bda1ddf..00000000 --- a/docs/source/generated/src.shiver.models.corrections.rst +++ /dev/null @@ -1,22 +0,0 @@ -src.shiver.models.corrections -============================= - -.. automodule:: src.shiver.models.corrections - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ApplyDetailedBalanceMDObserver - CorrectionsModel - DgsScatteredTransmissionCorrectionMDObserver diff --git a/docs/source/generated/src.shiver.models.generate.rst b/docs/source/generated/src.shiver.models.generate.rst deleted file mode 100644 index 22366969..00000000 --- a/docs/source/generated/src.shiver.models.generate.rst +++ /dev/null @@ -1,28 +0,0 @@ -src.shiver.models.generate -========================== - -.. automodule:: src.shiver.models.generate - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - gather_mde_config_dict - - - - - - .. rubric:: Classes - - .. autosummary:: - - GenerateMDEObserver - GenerateModel - SaveMDObserver diff --git a/docs/source/generated/src.shiver.models.generate_dgs_mde.rst b/docs/source/generated/src.shiver.models.generate_dgs_mde.rst deleted file mode 100644 index c97a1b59..00000000 --- a/docs/source/generated/src.shiver.models.generate_dgs_mde.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.models.generate\_dgs\_mde -==================================== - -.. automodule:: src.shiver.models.generate_dgs_mde - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - GenerateDGSMDE diff --git a/docs/source/generated/src.shiver.models.help.rst b/docs/source/generated/src.shiver.models.help.rst deleted file mode 100644 index 3ee2799e..00000000 --- a/docs/source/generated/src.shiver.models.help.rst +++ /dev/null @@ -1,16 +0,0 @@ -src.shiver.models.help -====================== - -.. automodule:: src.shiver.models.help - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - help_function diff --git a/docs/source/generated/src.shiver.models.histogram.rst b/docs/source/generated/src.shiver.models.histogram.rst deleted file mode 100644 index 354e5f2c..00000000 --- a/docs/source/generated/src.shiver.models.histogram.rst +++ /dev/null @@ -1,32 +0,0 @@ -src.shiver.models.histogram -=========================== - -.. automodule:: src.shiver.models.histogram - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - dim2array - filter_ws - get_frame - get_num_non_integrated_dims - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADSObserver - FileLoadingObserver - HistogramModel - MakeSliceObserver diff --git a/docs/source/generated/src.shiver.models.makeslice.rst b/docs/source/generated/src.shiver.models.makeslice.rst deleted file mode 100644 index 99e4e223..00000000 --- a/docs/source/generated/src.shiver.models.makeslice.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.models.makeslice -=========================== - -.. automodule:: src.shiver.models.makeslice - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - MakeSlice diff --git a/docs/source/generated/src.shiver.models.sample.rst b/docs/source/generated/src.shiver.models.sample.rst deleted file mode 100644 index 78ed5f27..00000000 --- a/docs/source/generated/src.shiver.models.sample.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.models.sample -======================== - -.. automodule:: src.shiver.models.sample - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - SampleModel diff --git a/docs/source/generated/src.shiver.models.utils.rst b/docs/source/generated/src.shiver.models.utils.rst deleted file mode 100644 index 1cd0e6b0..00000000 --- a/docs/source/generated/src.shiver.models.utils.rst +++ /dev/null @@ -1,16 +0,0 @@ -src.shiver.models.utils -======================= - -.. automodule:: src.shiver.models.utils - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - flatten_list diff --git a/docs/source/generated/src.shiver.presenters.generate.rst b/docs/source/generated/src.shiver.presenters.generate.rst deleted file mode 100644 index 3403604d..00000000 --- a/docs/source/generated/src.shiver.presenters.generate.rst +++ /dev/null @@ -1,26 +0,0 @@ -src.shiver.presenters.generate -============================== - -.. automodule:: src.shiver.presenters.generate - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - translate_filelist_to_string - - - - - - .. rubric:: Classes - - .. autosummary:: - - GeneratePresenter diff --git a/docs/source/generated/src.shiver.presenters.histogram.rst b/docs/source/generated/src.shiver.presenters.histogram.rst deleted file mode 100644 index 70129e41..00000000 --- a/docs/source/generated/src.shiver.presenters.histogram.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.presenters.histogram -=============================== - -.. automodule:: src.shiver.presenters.histogram - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - HistogramPresenter diff --git a/docs/source/generated/src.shiver.presenters.sample.rst b/docs/source/generated/src.shiver.presenters.sample.rst deleted file mode 100644 index cd7292a7..00000000 --- a/docs/source/generated/src.shiver.presenters.sample.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.presenters.sample -============================ - -.. automodule:: src.shiver.presenters.sample - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - SamplePresenter diff --git a/docs/source/generated/src.shiver.shiver.rst b/docs/source/generated/src.shiver.shiver.rst deleted file mode 100644 index c9de3584..00000000 --- a/docs/source/generated/src.shiver.shiver.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.shiver -================= - -.. automodule:: src.shiver.shiver - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Shiver diff --git a/docs/source/generated/src.shiver.version.rst b/docs/source/generated/src.shiver.version.rst deleted file mode 100644 index 93f28b75..00000000 --- a/docs/source/generated/src.shiver.version.rst +++ /dev/null @@ -1,4 +0,0 @@ -src.shiver.version -================== - -.. automodule:: src.shiver.version diff --git a/docs/source/generated/src.shiver.views.advanced_options.rst b/docs/source/generated/src.shiver.views.advanced_options.rst deleted file mode 100644 index c4fa336a..00000000 --- a/docs/source/generated/src.shiver.views.advanced_options.rst +++ /dev/null @@ -1,27 +0,0 @@ -src.shiver.views.advanced\_options -================================== - -.. automodule:: src.shiver.views.advanced_options - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - return_valid - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADValidator - AdvancedDialog diff --git a/docs/source/generated/src.shiver.views.corrections.rst b/docs/source/generated/src.shiver.views.corrections.rst deleted file mode 100644 index e2e46465..00000000 --- a/docs/source/generated/src.shiver.views.corrections.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.views.corrections -============================ - -.. automodule:: src.shiver.views.corrections - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Corrections diff --git a/docs/source/generated/src.shiver.views.data.rst b/docs/source/generated/src.shiver.views.data.rst deleted file mode 100644 index e1f8ccce..00000000 --- a/docs/source/generated/src.shiver.views.data.rst +++ /dev/null @@ -1,26 +0,0 @@ -src.shiver.views.data -===================== - -.. automodule:: src.shiver.views.data - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - filename_str_to_list - - - - - - .. rubric:: Classes - - .. autosummary:: - - RawData diff --git a/docs/source/generated/src.shiver.views.generate.rst b/docs/source/generated/src.shiver.views.generate.rst deleted file mode 100644 index ef9719c4..00000000 --- a/docs/source/generated/src.shiver.views.generate.rst +++ /dev/null @@ -1,29 +0,0 @@ -src.shiver.views.generate -========================= - -.. automodule:: src.shiver.views.generate - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - has_special_char - is_valid_name - - - - - - .. rubric:: Classes - - .. autosummary:: - - Buttons - Generate - MDEType diff --git a/docs/source/generated/src.shiver.views.histogram.rst b/docs/source/generated/src.shiver.views.histogram.rst deleted file mode 100644 index 5f9fba79..00000000 --- a/docs/source/generated/src.shiver.views.histogram.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.views.histogram -========================== - -.. automodule:: src.shiver.views.histogram - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - Histogram diff --git a/docs/source/generated/src.shiver.views.histogram_parameters.rst b/docs/source/generated/src.shiver.views.histogram_parameters.rst deleted file mode 100644 index 1a991e18..00000000 --- a/docs/source/generated/src.shiver.views.histogram_parameters.rst +++ /dev/null @@ -1,29 +0,0 @@ -src.shiver.views.histogram\_parameters -====================================== - -.. automodule:: src.shiver.views.histogram_parameters - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - return_valid - translation - - - - - - .. rubric:: Classes - - .. autosummary:: - - Dimensions - HistogramParameter - V3DValidator diff --git a/docs/source/generated/src.shiver.views.invalid_styles.rst b/docs/source/generated/src.shiver.views.invalid_styles.rst deleted file mode 100644 index 35e66aa1..00000000 --- a/docs/source/generated/src.shiver.views.invalid_styles.rst +++ /dev/null @@ -1,4 +0,0 @@ -src.shiver.views.invalid\_styles -================================ - -.. automodule:: src.shiver.views.invalid_styles diff --git a/docs/source/generated/src.shiver.views.loading_buttons.rst b/docs/source/generated/src.shiver.views.loading_buttons.rst deleted file mode 100644 index 2d40b2fd..00000000 --- a/docs/source/generated/src.shiver.views.loading_buttons.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.views.loading\_buttons -================================= - -.. automodule:: src.shiver.views.loading_buttons - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - LoadingButtons diff --git a/docs/source/generated/src.shiver.views.mainwindow.rst b/docs/source/generated/src.shiver.views.mainwindow.rst deleted file mode 100644 index 9a076400..00000000 --- a/docs/source/generated/src.shiver.views.mainwindow.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.views.mainwindow -=========================== - -.. automodule:: src.shiver.views.mainwindow - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - MainWindow diff --git a/docs/source/generated/src.shiver.views.oncat.rst b/docs/source/generated/src.shiver.views.oncat.rst deleted file mode 100644 index 568cab2c..00000000 --- a/docs/source/generated/src.shiver.views.oncat.rst +++ /dev/null @@ -1,31 +0,0 @@ -src.shiver.views.oncat -====================== - -.. automodule:: src.shiver.views.oncat - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - get_data_from_oncat - get_dataset_info - get_dataset_names - - - - - - .. rubric:: Classes - - .. autosummary:: - - OnCatAgent - OnCatLogin - Oncat - OncatToken diff --git a/docs/source/generated/src.shiver.views.plots.rst b/docs/source/generated/src.shiver.views.plots.rst deleted file mode 100644 index 0d0150aa..00000000 --- a/docs/source/generated/src.shiver.views.plots.rst +++ /dev/null @@ -1,16 +0,0 @@ -src.shiver.views.plots -====================== - -.. automodule:: src.shiver.views.plots - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - do_default_plot diff --git a/docs/source/generated/src.shiver.views.polarized_options.rst b/docs/source/generated/src.shiver.views.polarized_options.rst deleted file mode 100644 index 6f74818d..00000000 --- a/docs/source/generated/src.shiver.views.polarized_options.rst +++ /dev/null @@ -1,27 +0,0 @@ -src.shiver.views.polarized\_options -=================================== - -.. automodule:: src.shiver.views.polarized_options - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - return_valid - - - - - - .. rubric:: Classes - - .. autosummary:: - - PolarizedDialog - RatioValidator diff --git a/docs/source/generated/src.shiver.views.reduction_parameters.rst b/docs/source/generated/src.shiver.views.reduction_parameters.rst deleted file mode 100644 index 33f5a527..00000000 --- a/docs/source/generated/src.shiver.views.reduction_parameters.rst +++ /dev/null @@ -1,20 +0,0 @@ -src.shiver.views.reduction\_parameters -====================================== - -.. automodule:: src.shiver.views.reduction_parameters - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ReductionParameters diff --git a/docs/source/generated/src.shiver.views.sample.rst b/docs/source/generated/src.shiver.views.sample.rst deleted file mode 100644 index 48ca3c6a..00000000 --- a/docs/source/generated/src.shiver.views.sample.rst +++ /dev/null @@ -1,22 +0,0 @@ -src.shiver.views.sample -======================= - -.. automodule:: src.shiver.views.sample - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - LatticeParametersWidget - SampleDialog - SampleView diff --git a/docs/source/generated/src.shiver.views.workspace_tables.rst b/docs/source/generated/src.shiver.views.workspace_tables.rst deleted file mode 100644 index 1fede581..00000000 --- a/docs/source/generated/src.shiver.views.workspace_tables.rst +++ /dev/null @@ -1,33 +0,0 @@ -src.shiver.views.workspace\_tables -================================== - -.. automodule:: src.shiver.views.workspace_tables - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - get_icon - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADSList - Frame - HistogramWorkspaces - IconLegend - InputWorkspaces - MDEList - MDHList - NormList diff --git a/docs/source/generated/tests.conftest.rst b/docs/source/generated/tests.conftest.rst deleted file mode 100644 index 3b875ef7..00000000 --- a/docs/source/generated/tests.conftest.rst +++ /dev/null @@ -1,17 +0,0 @@ -tests.conftest -============== - -.. automodule:: tests.conftest - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - clear_ads - shiver_app diff --git a/docs/source/generated/tests.data.define_data.rst b/docs/source/generated/tests.data.define_data.rst deleted file mode 100644 index 5e1c04b3..00000000 --- a/docs/source/generated/tests.data.define_data.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.data.define\_data -======================= - -.. automodule:: tests.data.define_data - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - define_data_set diff --git a/docs/source/generated/tests.models.test_gather_history.rst b/docs/source/generated/tests.models.test_gather_history.rst deleted file mode 100644 index de535e69..00000000 --- a/docs/source/generated/tests.models.test_gather_history.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.models.test\_gather\_history -================================== - -.. automodule:: tests.models.test_gather_history - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_get_make_slice_history diff --git a/docs/source/generated/tests.models.test_generate_model.rst b/docs/source/generated/tests.models.test_generate_model.rst deleted file mode 100644 index ad599cbd..00000000 --- a/docs/source/generated/tests.models.test_generate_model.rst +++ /dev/null @@ -1,17 +0,0 @@ -tests.models.test\_generate\_model -================================== - -.. automodule:: tests.models.test_generate_model - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_gather_mde_config_dict - test_generate_mde_model diff --git a/docs/source/generated/tests.models.test_generatemde.rst b/docs/source/generated/tests.models.test_generatemde.rst deleted file mode 100644 index 0006317e..00000000 --- a/docs/source/generated/tests.models.test_generatemde.rst +++ /dev/null @@ -1,24 +0,0 @@ -tests.models.test\_generatemde -============================== - -.. automodule:: tests.models.test_generatemde - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_convert_dgs_to_single_mde_additional_dims - test_convert_dgs_to_single_mde_calculate_t0_ei - test_convert_dgs_to_single_mde_mask - test_convert_dgs_to_single_mde_merged - test_convert_dgs_to_single_mde_single_qlab - test_convert_dgs_to_single_mde_single_qsample - test_generate_dgs_mde - test_generate_dgs_mde_bkg - test_generate_dgs_mde_seq diff --git a/docs/source/generated/tests.models.test_histogram_saving.rst b/docs/source/generated/tests.models.test_histogram_saving.rst deleted file mode 100644 index 338355ef..00000000 --- a/docs/source/generated/tests.models.test_histogram_saving.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.models.test\_histogram\_saving -==================================== - -.. automodule:: tests.models.test_histogram_saving - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_saving diff --git a/docs/source/generated/tests.models.test_load.rst b/docs/source/generated/tests.models.test_load.rst deleted file mode 100644 index 22feef3e..00000000 --- a/docs/source/generated/tests.models.test_load.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.models.test\_load -======================= - -.. automodule:: tests.models.test_load - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_bad_file - test_load_dataset - test_load_mde - test_load_norm - test_nonexisted_file diff --git a/docs/source/generated/tests.models.test_makeslice.rst b/docs/source/generated/tests.models.test_makeslice.rst deleted file mode 100644 index 337be3b2..00000000 --- a/docs/source/generated/tests.models.test_makeslice.rst +++ /dev/null @@ -1,18 +0,0 @@ -tests.models.test\_makeslice -============================ - -.. automodule:: tests.models.test_makeslice - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_2d_slice - test_make_slice_1d - test_make_slice_1d_inelastic diff --git a/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst b/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst deleted file mode 100644 index 7cf15572..00000000 --- a/docs/source/generated/tests.models.test_sample_parameters_buttons_actions.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.models.test\_sample\_parameters\_buttons\_actions -======================================================= - -.. automodule:: tests.models.test_sample_parameters_buttons_actions - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_apply_button_invalid - test_apply_button_valid - test_isaw_button_invalid - test_nexus_button_invalid - test_procesed_nexus_button_invalid diff --git a/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst b/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst deleted file mode 100644 index 53bc5fa0..00000000 --- a/docs/source/generated/tests.models.test_sample_parameters_invalid_inputs.rst +++ /dev/null @@ -1,19 +0,0 @@ -tests.models.test\_sample\_parameters\_invalid\_inputs -====================================================== - -.. automodule:: tests.models.test_sample_parameters_invalid_inputs - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_colinear_u_v - test_invalid_angles - test_invalid_matrix - test_invalid_workspace diff --git a/docs/source/generated/tests.models.test_save.rst b/docs/source/generated/tests.models.test_save.rst deleted file mode 100644 index 9d4dc231..00000000 --- a/docs/source/generated/tests.models.test_save.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.models.test\_save -======================= - -.. automodule:: tests.models.test_save - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_save_to_ascii diff --git a/docs/source/generated/tests.models.test_symmetry_operations.rst b/docs/source/generated/tests.models.test_symmetry_operations.rst deleted file mode 100644 index 016be42a..00000000 --- a/docs/source/generated/tests.models.test_symmetry_operations.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.models.test\_symmetry\_operations -======================================= - -.. automodule:: tests.models.test_symmetry_operations - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_symmetry_invalid - test_symmetry_valid_char_array - test_symmetry_valid_spacegroup - test_symmetry_valid_spacegroup_num - test_symmetry_valid_spacegroup_sym diff --git a/docs/source/generated/tests.models.test_utils.rst b/docs/source/generated/tests.models.test_utils.rst deleted file mode 100644 index cbf045c7..00000000 --- a/docs/source/generated/tests.models.test_utils.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.models.test\_utils -======================== - -.. automodule:: tests.models.test_utils - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_flatten_list diff --git a/docs/source/generated/tests.views.test_correction.rst b/docs/source/generated/tests.views.test_correction.rst deleted file mode 100644 index b055c66c..00000000 --- a/docs/source/generated/tests.views.test_correction.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.views.test\_correction -============================ - -.. automodule:: tests.views.test_correction - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_corrections_table diff --git a/docs/source/generated/tests.views.test_dimensions.rst b/docs/source/generated/tests.views.test_dimensions.rst deleted file mode 100644 index d39e3676..00000000 --- a/docs/source/generated/tests.views.test_dimensions.rst +++ /dev/null @@ -1,23 +0,0 @@ -tests.views.test\_dimensions -============================ - -.. automodule:: tests.views.test_dimensions - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_dimensions_dropdown_uniqueness - test_dimensions_min_max_color_invalid - test_dimensions_min_max_color_missing - test_dimensions_min_max_valid - test_dimensions_radio_btn - test_dimensions_ste_values_required_color - test_dimensions_step_values_invalid - test_dimensions_update_on_projection_edit diff --git a/docs/source/generated/tests.views.test_generate.rst b/docs/source/generated/tests.views.test_generate.rst deleted file mode 100644 index 75c64f96..00000000 --- a/docs/source/generated/tests.views.test_generate.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.views.test\_generate -========================== - -.. automodule:: tests.views.test_generate - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_generate_widget_colors_invalid - test_generate_widget_colors_valid - test_mde_name_check - test_mde_type_widget - test_path_check diff --git a/docs/source/generated/tests.views.test_histogram.rst b/docs/source/generated/tests.views.test_histogram.rst deleted file mode 100644 index a1854ba5..00000000 --- a/docs/source/generated/tests.views.test_histogram.rst +++ /dev/null @@ -1,21 +0,0 @@ -tests.views.test\_histogram -=========================== - -.. automodule:: tests.views.test_histogram - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_histogram - test_load_dataset_presenter - test_make_histogram_button - test_msg_dialog - test_norm_workspaces_menu - test_populate_ui_from_history_dict diff --git a/docs/source/generated/tests.views.test_histogram_button.rst b/docs/source/generated/tests.views.test_histogram_button.rst deleted file mode 100644 index 767d5ffb..00000000 --- a/docs/source/generated/tests.views.test_histogram_button.rst +++ /dev/null @@ -1,17 +0,0 @@ -tests.views.test\_histogram\_button -=================================== - -.. automodule:: tests.views.test_histogram_button - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_dictionary_creation_histogram_btn - test_update_plot_num diff --git a/docs/source/generated/tests.views.test_loading_buttons.rst b/docs/source/generated/tests.views.test_loading_buttons.rst deleted file mode 100644 index 6c2aa67d..00000000 --- a/docs/source/generated/tests.views.test_loading_buttons.rst +++ /dev/null @@ -1,17 +0,0 @@ -tests.views.test\_loading\_buttons -================================== - -.. automodule:: tests.views.test_loading_buttons - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_file_loading - test_load_dataset_button diff --git a/docs/source/generated/tests.views.test_mainwindow.rst b/docs/source/generated/tests.views.test_mainwindow.rst deleted file mode 100644 index 757ff28e..00000000 --- a/docs/source/generated/tests.views.test_mainwindow.rst +++ /dev/null @@ -1,16 +0,0 @@ -tests.views.test\_mainwindow -============================ - -.. automodule:: tests.views.test_mainwindow - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_mainwindow diff --git a/docs/source/generated/tests.views.test_mde_workspaces.rst b/docs/source/generated/tests.views.test_mde_workspaces.rst deleted file mode 100644 index 6aacd7f2..00000000 --- a/docs/source/generated/tests.views.test_mde_workspaces.rst +++ /dev/null @@ -1,17 +0,0 @@ -tests.views.test\_mde\_workspaces -================================= - -.. automodule:: tests.views.test_mde_workspaces - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_mde_workspaces_icon - test_mde_workspaces_menu diff --git a/docs/source/generated/tests.views.test_mdh_workspaces.rst b/docs/source/generated/tests.views.test_mdh_workspaces.rst deleted file mode 100644 index e3b7bbde..00000000 --- a/docs/source/generated/tests.views.test_mdh_workspaces.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.views.test\_mdh\_workspaces -================================= - -.. automodule:: tests.views.test_mdh_workspaces - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - handle_menu - test_mdh_plotting_1d - test_mdh_plotting_2d - test_mdh_plotting_3d - test_mdh_workspaces_menu diff --git a/docs/source/generated/tests.views.test_oncat.rst b/docs/source/generated/tests.views.test_oncat.rst deleted file mode 100644 index 40a29b83..00000000 --- a/docs/source/generated/tests.views.test_oncat.rst +++ /dev/null @@ -1,33 +0,0 @@ -tests.views.test\_oncat -======================= - -.. automodule:: tests.views.test_oncat - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_get_data_from_oncat - test_get_dataset_info - test_get_dataset_names - test_oncat - test_oncat_agent - test_oncat_login - test_oncat_token - - - - - - .. rubric:: Classes - - .. autosummary:: - - MockONcat - MockRecord diff --git a/docs/source/generated/tests.views.test_polarized_options.rst b/docs/source/generated/tests.views.test_polarized_options.rst deleted file mode 100644 index 37d4333b..00000000 --- a/docs/source/generated/tests.views.test_polarized_options.rst +++ /dev/null @@ -1,28 +0,0 @@ -tests.views.test\_polarized\_options -==================================== - -.. automodule:: tests.views.test_polarized_options - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_apply_btn_invalid - test_apply_btn_valid - test_apply_btn_valid_all - test_help_button - test_polarized_options_initialization_from_dict_invalid - test_polarized_options_initialization_from_dict_nsf - test_polarized_options_initialization_from_dict_unpolarized - test_polarized_options_invalid_psda - test_polarized_options_invalid_ratio_log - test_polarized_options_no_spin - test_polarized_options_ratio_num - test_polarized_options_spin - test_polarized_options_unpolarized diff --git a/docs/source/generated/tests.views.test_projections.rst b/docs/source/generated/tests.views.test_projections.rst deleted file mode 100644 index aa9b5a5f..00000000 --- a/docs/source/generated/tests.views.test_projections.rst +++ /dev/null @@ -1,18 +0,0 @@ -tests.views.test\_projections -============================= - -.. automodule:: tests.views.test_projections - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_projections_co_linear_color - test_projections_invalid_color - test_projections_valid_values diff --git a/docs/source/generated/tests.views.test_raw_data.rst b/docs/source/generated/tests.views.test_raw_data.rst deleted file mode 100644 index 079ed389..00000000 --- a/docs/source/generated/tests.views.test_raw_data.rst +++ /dev/null @@ -1,20 +0,0 @@ -tests.views.test\_raw\_data -=========================== - -.. automodule:: tests.views.test_raw_data - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_filename_str_to_list - test_populate_data_widget_from_dict - test_raw_data_editing_path - test_raw_data_get_selection - test_raw_data_set_selection diff --git a/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst b/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst deleted file mode 100644 index 9cd32698..00000000 --- a/docs/source/generated/tests.views.test_reduction_parameters_inputs.rst +++ /dev/null @@ -1,23 +0,0 @@ -tests.views.test\_reduction\_parameters\_inputs -=============================================== - -.. automodule:: tests.views.test_reduction_parameters_inputs - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_reduction_parameters_get_data_first_level - test_reduction_parameters_initialization_from_dict_reduct - test_reduction_parameters_initialization_from_dict_to_dict - test_reduction_parameters_mask_valid_input - test_reduction_parameters_norm_valid_input - test_reduction_parameters_text_invalid_input - test_reduction_parameters_text_invalid_numbers - test_reduction_parameters_text_valid_input diff --git a/docs/source/generated/tests.views.test_sample_parameters_buttons.rst b/docs/source/generated/tests.views.test_sample_parameters_buttons.rst deleted file mode 100644 index 04a9a62a..00000000 --- a/docs/source/generated/tests.views.test_sample_parameters_buttons.rst +++ /dev/null @@ -1,22 +0,0 @@ -tests.views.test\_sample\_parameters\_buttons -============================================= - -.. automodule:: tests.views.test_sample_parameters_buttons - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_get_data_sample_after_apply - test_help_button - test_isaw_button - test_load_processed_button - test_nexus_button - test_sample_parameters_updates_and_load_button - test_sample_parameters_updates_invalid_and_load_button diff --git a/docs/source/generated/tests.views.test_sample_parameters_inputs.rst b/docs/source/generated/tests.views.test_sample_parameters_inputs.rst deleted file mode 100644 index 196422d3..00000000 --- a/docs/source/generated/tests.views.test_sample_parameters_inputs.rst +++ /dev/null @@ -1,24 +0,0 @@ -tests.views.test\_sample\_parameters\_inputs -============================================ - -.. automodule:: tests.views.test_sample_parameters_inputs - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - test_lattice_parameters_invalid_input - test_lattice_parameters_valid_input - test_sample_parameters_initialization - test_sample_parameters_initialization_from_dict - test_sample_parameters_initialization_from_dict_invalid - test_sample_parameters_initialization_no_workspace - test_sample_parameters_updates - test_ub_matrix_invalid_input - test_ub_matrix_valid_input diff --git a/docs/source/index.rst b/docs/source/index.rst index dedd8c51..ed613257 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,6 +28,7 @@ Contents -------- .. toctree:: + :maxdepth: 1 getting_started usage diff --git a/docs/source/repo_doc.rst b/docs/source/repo_doc.rst index a8621c76..73a4ec95 100644 --- a/docs/source/repo_doc.rst +++ b/docs/source/repo_doc.rst @@ -1,74 +1,97 @@ Repository Documentation ======================== -.. autosummary:: - :toctree: generated - - src.shiver.version - src.shiver.shiver - src.shiver.models.sample - src.shiver.models.help - src.shiver.models.generate - src.shiver.models.convert_dgs_to_single_mde - src.shiver.models.makeslice - src.shiver.models.generate_dgs_mde - src.shiver.models.corrections - src.shiver.models.utils - src.shiver.models.histogram - src.shiver.presenters.sample - src.shiver.presenters.generate - src.shiver.presenters.histogram - src.shiver.views.histogram_parameters - src.shiver.views.sample - src.shiver.views.invalid_styles - src.shiver.views.oncat - src.shiver.views.generate - src.shiver.views.advanced_options - src.shiver.views.data - src.shiver.views.loading_buttons - src.shiver.views.workspace_tables - src.shiver.views.plots - src.shiver.views.mainwindow - src.shiver.views.reduction_parameters - src.shiver.views.corrections - src.shiver.views.polarized_options - src.shiver.views.histogram - tests.conftest - tests.models.test_generate_model - tests.models.test_sample_parameters_invalid_inputs - tests.models.test_sample_parameters_buttons_actions - tests.models.test_generatemde - tests.models.test_symmetry_operations - tests.models.test_makeslice - tests.models.test_save - tests.models.test_utils - tests.models.test_gather_history - tests.models.test_load - tests.models.test_histogram_saving - tests.data.define_data - tests.views.test_dimensions - tests.views.test_polarized_options - tests.views.test_oncat - tests.views.test_raw_data - tests.views.test_projections - tests.views.test_loading_buttons - tests.views.test_sample_parameters_inputs - tests.views.test_generate - tests.views.test_correction - tests.views.test_sample_parameters_buttons - tests.views.test_mdh_workspaces - tests.views.test_histogram - tests.views.test_mainwindow - tests.views.test_histogram_button - tests.views.test_mde_workspaces - tests.views.test_reduction_parameters_inputs - DGS_SC_scripts.slice_utils - DGS_SC_scripts.define_slices_example_polarized - DGS_SC_scripts.reduce_data_to_MDE - DGS_SC_scripts.slice_maker_example1 - DGS_SC_scripts.slice_maker_example_polarized - DGS_SC_scripts.define_data_example_polarized - DGS_SC_scripts.define_slices_example1 - DGS_SC_scripts.oncat_example - DGS_SC_scripts.define_data_example1 - DGS_SC_scripts.oncat_util +Shiver +------ +.. automodule:: src.shiver.shiver + :members: + +Models +------ + +.. automodule:: src.shiver.models.sample + :members: + +.. automodule:: src.shiver.models.help + :members: + +.. automodule:: src.shiver.models.generate + :members: + +.. automodule:: src.shiver.models.convert_dgs_to_single_mde + :members: + +.. automodule:: src.shiver.models.makeslice + :members: + +.. automodule:: src.shiver.models.generate_dgs_mde + :members: + +.. automodule:: src.shiver.models.corrections + :members: + +.. automodule:: src.shiver.models.utils + :members: + +.. automodule:: src.shiver.models.histogram + :members: + +Presenters +---------- + +.. automodule:: src.shiver.presenters.sample + :members: + +.. automodule:: src.shiver.presenters.generate + :members: + +.. automodule:: src.shiver.presenters.histogram + :members: + +Views +----- + +.. automodule:: src.shiver.views.histogram_parameters + :members: + +.. automodule:: src.shiver.views.sample + :members: + +.. automodule:: src.shiver.views.invalid_styles + :members: + +.. automodule:: src.shiver.views.oncat + :members: + +.. automodule:: src.shiver.views.generate + :members: + +.. automodule:: src.shiver.views.advanced_options + :members: + +.. automodule:: src.shiver.views.data + :members: + +.. automodule:: src.shiver.views.loading_buttons + :members: + +.. automodule:: src.shiver.views.workspace_tables + :members: + +.. automodule:: src.shiver.views.plots + :members: + +.. automodule:: src.shiver.views.mainwindow + :members: + +.. automodule:: src.shiver.views.reduction_parameters + :members: + +.. automodule:: src.shiver.views.corrections + :members: + +.. automodule:: src.shiver.views.polarized_options + :members: + +.. automodule:: src.shiver.views.histogram + :members: diff --git a/src/shiver/views/oncat.py b/src/shiver/views/oncat.py index 0d93aa3e..06da5920 100644 --- a/src/shiver/views/oncat.py +++ b/src/shiver/views/oncat.py @@ -598,7 +598,7 @@ def get_dataset_info( # pylint: disable=too-many-branches If any of the include_runs is already in the dataset If any of the exclude_runs is not already accounted for If no runs were found to match the criteria (for example, - dataset_name=None and include_runs=None) + dataset_name=None and include_runs=None) """ # get run number, angle, and sequence names from oncat projection = ["indexed.run_number", f"metadata.entry.daslogs.{angle_pv}"] From ead3c76afd6c0cda91f2d9d45ba4daba05ea8b4b Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 15:14:17 -0400 Subject: [PATCH 06/13] Removed deploy.rst from sphinx documentation as requested. Added instructions on updating documentation within the README.md file. --- README.md | 17 +++++++++++ docs/source/deploy.rst | 69 ------------------------------------------ docs/source/index.rst | 1 - 3 files changed, 17 insertions(+), 70 deletions(-) delete mode 100644 docs/source/deploy.rst diff --git a/README.md b/README.md index 459d9a83..1890ef1a 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,23 @@ To set the pre-commit hook before each git commit pre-commit install ``` +--- +**NOTE** + +When adding new views, presenters and methods. Please navigate to SHIVER/docs/source/repo_doc.rst. +Add the new feature under the appropriate section following the given template: + +.. automodule:: path.to.new.module + :members: + +Once complete, rebuild the documentation: + + 1. Navigate to SHIVER/docs/ + 2. make clean + 3. make html + +--- + [![CI](https://github.com/neutrons/Shiver/actions/workflows/actions.yml/badge.svg?branch=next)](https://github.com/neutrons/Shiver/actions/workflows/actions.yml) [![codecov](https://codecov.io/gh/neutrons/shiver/branch/next/graph/badge.svg?token=J1ZNHXF6Ml)](https://codecov.io/gh/neutrons/shiver) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7381/badge)](https://bestpractices.coreinfrastructure.org/projects/7381) diff --git a/docs/source/deploy.rst b/docs/source/deploy.rst deleted file mode 100644 index 7c5b5e9c..00000000 --- a/docs/source/deploy.rst +++ /dev/null @@ -1,69 +0,0 @@ -Deployments -=========== - -.. _deploy: - -Branches --------- - -The repository contains three main-permanent branches: - -* `next `_ - -This is the central branch that all other branches are created by -``e.g., git checkout -b next`` - -* `main `_ - -No development allowed in this branch. The branch is a result of the next branch -(for production release). The next branch is merged into this one manually. -When you put the tag (without rc suffix), this should be updated from -next manually; more on tags in the `Tags`_ section. - -* `qa `_ - -No development allowed in this branch. The branch is a results of the next branch -(for the qa release). The next branch is merged into this one manually. When -you put the tag (with rc suffix), this should be updated from next manually; -more on tahs in the `Tags`_ section. - -Code Contribution ------------------ - -After creating a temporary branch from *next* locally, developers can make -changes to the code. Before commiting-pushing any changes on the remote -repository: - -1. Run pre-commit manually: ``pre-commit run --all-files`` and/or set it -before each commit ``pre-commit install`` - -2. Run all tests (including your newly created ones, if necessary) within -``pytest`` to ensure everything passes. - - -.. note:: Additional Information Regarding Mantid - - Some mantid algorithms/concepts used in the project: `ConvertToMD `_, - `MDNorm `_ and ``Workspace`` dimensionality. - - In ``SHIVER``, ``mantid`` algorithms are executed asynchronously using the ``AlgorithmManager``. - This allows the progress bar to be displayed, while waiting for the algorithm completion, and - the GUI to be responsive. - -.. _Tags: - -Tags ----- - -The branches: ``qa`` and ``main`` need to be approved with the latest code -from ``next``. After approval, we assign a tag as follows: - -From command line on the corresponding branch ``(main/qa)``: - -.. code-block:: sh - - git tag - git push origin -tags - -Click `here `_ -for more information. diff --git a/docs/source/index.rst b/docs/source/index.rst index ed613257..fe0db8e6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,4 +33,3 @@ Contents getting_started usage repo_doc - deploy From a268ec85775e3eebf3f77ac75a60d0d7b889aef6 Mon Sep 17 00:00:00 2001 From: darshdinger Date: Fri, 11 Aug 2023 15:28:25 -0400 Subject: [PATCH 07/13] Updating formatting. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1890ef1a..55f3d484 100644 --- a/README.md +++ b/README.md @@ -50,17 +50,18 @@ pre-commit install --- **NOTE** -When adding new views, presenters and methods. Please navigate to SHIVER/docs/source/repo_doc.rst. -Add the new feature under the appropriate section following the given template: +When adding new views, presenters and methods. Please navigate to SHIVER/docs/source/repo_doc.rst. Add the new feature under the appropriate section following the given template: +```bash .. automodule:: path.to.new.module :members: +``` Once complete, rebuild the documentation: - 1. Navigate to SHIVER/docs/ - 2. make clean - 3. make html + cd SHIVER/docs/ + make clean + make html --- From ca7e46dc347b9b3e5b4a0db2543331f953194703 Mon Sep 17 00:00:00 2001 From: Darsh Dinger <106342815+darshdinger@users.noreply.github.com> Date: Mon, 21 Aug 2023 13:13:06 -0400 Subject: [PATCH 08/13] Update conf.py --- docs/source/conf.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 51af3d62..4dbdb2e0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,11 +17,11 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "SHIVER" -copyright = "2022, ORNL" -author = "ORNL" +project = "SHIVER" #pylint: disable=C0103 +copyright = "2022, ORNL" # pylint: disable=W0622, C0103 +author = "ORNL" #pylint: disable=C0103 version = versioningit.get_version("../../") -release = ".".join(version.split(".")[:-1]) +release = ".".join(version.split(".")[:-1]) #pylint: disable=C0103 # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -47,8 +47,8 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "sphinx_rtd_theme" +html_theme = "sphinx_rtd_theme" #pylint: disable=C0103 html_theme_options = {"style_nav_header_background": "#472375"} -epub_show_urls = "footnote" +epub_show_urls = "footnote" #pylint: disable=C0103 From d774a17df6440a9c5c6af90d4dde67a3f62fba52 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 21 Aug 2023 17:13:18 +0000 Subject: [PATCH 09/13] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/conf.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4dbdb2e0..de9b65d5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,11 +17,11 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "SHIVER" #pylint: disable=C0103 -copyright = "2022, ORNL" # pylint: disable=W0622, C0103 -author = "ORNL" #pylint: disable=C0103 +project = "SHIVER" # pylint: disable=C0103 +copyright = "2022, ORNL" # pylint: disable=W0622, C0103 +author = "ORNL" # pylint: disable=C0103 version = versioningit.get_version("../../") -release = ".".join(version.split(".")[:-1]) #pylint: disable=C0103 +release = ".".join(version.split(".")[:-1]) # pylint: disable=C0103 # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -47,8 +47,8 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "sphinx_rtd_theme" #pylint: disable=C0103 +html_theme = "sphinx_rtd_theme" # pylint: disable=C0103 html_theme_options = {"style_nav_header_background": "#472375"} -epub_show_urls = "footnote" #pylint: disable=C0103 +epub_show_urls = "footnote" # pylint: disable=C0103 From c031fc0302201db11abbfc64659117d7b7309c0e Mon Sep 17 00:00:00 2001 From: darshdinger Date: Mon, 21 Aug 2023 13:26:50 -0400 Subject: [PATCH 10/13] Fixed test. --- tests/views/test_raw_data.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/views/test_raw_data.py b/tests/views/test_raw_data.py index 314d359b..95e686f3 100644 --- a/tests/views/test_raw_data.py +++ b/tests/views/test_raw_data.py @@ -35,7 +35,7 @@ def handle_dialog(): qtbot.wait(200) - assert raw_data.files.count() == 8 + assert raw_data.files.count() == 0 assert raw_data.get_selected() == [] # select 2nd and 4th items From 271806f1331d319867df1bd4ed579a23888ab0ee Mon Sep 17 00:00:00 2001 From: darshdinger Date: Mon, 21 Aug 2023 13:43:44 -0400 Subject: [PATCH 11/13] Reverted previous test fix. Issue with local environment. --- tests/views/test_raw_data.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/views/test_raw_data.py b/tests/views/test_raw_data.py index 95e686f3..314d359b 100644 --- a/tests/views/test_raw_data.py +++ b/tests/views/test_raw_data.py @@ -35,7 +35,7 @@ def handle_dialog(): qtbot.wait(200) - assert raw_data.files.count() == 0 + assert raw_data.files.count() == 8 assert raw_data.get_selected() == [] # select 2nd and 4th items From 39ca7b74351e306516f601333b379e7eb5147124 Mon Sep 17 00:00:00 2001 From: darshdinger Date: Thu, 24 Aug 2023 15:49:38 -0400 Subject: [PATCH 12/13] Made fixes based on comments. --- README.md | 2 +- docs/source/index.rst | 4 ++-- docs/source/usage.rst | 7 +------ 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 55f3d484..fcfd111b 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ pre-commit install --- **NOTE** -When adding new views, presenters and methods. Please navigate to SHIVER/docs/source/repo_doc.rst. Add the new feature under the appropriate section following the given template: +When adding new views, presenters and methods. Please navigate to docs/source/repo_doc.rst. Add the new feature under the appropriate section following the given template: ```bash .. automodule:: path.to.new.module diff --git a/docs/source/index.rst b/docs/source/index.rst index fe0db8e6..62a645e7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,12 +3,12 @@ Welcome to SHIVER's documentation! ================================== -The Spectroscopy HIstogram Visulizer for Event Reduction **(SHIVER)** is a tool to +The Spectroscopy HIstogram Visualizer for Event Reduction **(SHIVER)** is a tool to allow examination of time of flight inelastic neutron data, from single crystal, direct geometry experiments. It is intended to perform the following tasks: * Transform time of flight data from multiple orientations into a single intermediate - structure in units of reciprocal space and energy transfer + structure in units of reciprocal space and energy transfer. * Allow slicing of the intermediate file and creation of histograms containing S(**Q**, ∆ *E*) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 251f4629..9add1aea 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -17,10 +17,6 @@ geometry inelastic data related to spectroscopy event reduction. It is built as a python package and can be used either as a standalone application or as a package imported in Mantid workbench. -In the Main tab, the user can load Nexus files to create histrograms. -Additional parameters are set to in the main and generate tab to alter and -plot the data. - .. note:: `Github Shiver Repository `_ @@ -36,8 +32,7 @@ Project Structure The main code of the project is at src/shiver and the tests are at ``tests/`` folders. The project contains additional scripts at ``DGS_SC_scripts/`` folder, -which are initial (development) legacy scripts that ``SHIVER`` was created around -them. +which are initial scripts that ``SHIVER`` was created around. The code follows the `MVP (Model-View-Presenter) `_ Thus, all current and future changes will follow this pattern. From e630bcf0417c41872681c649fb1d3b469812d05e Mon Sep 17 00:00:00 2001 From: darshdinger Date: Thu, 24 Aug 2023 15:50:24 -0400 Subject: [PATCH 13/13] Added personal local launch.json file to .gitignore. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 938f7f37..6028f484 100644 --- a/.gitignore +++ b/.gitignore @@ -129,3 +129,4 @@ dmypy.json .pyre/ src/shiver/_version.py +.vscode/launch.json