restructure directories

Signed-off-by: Jose Borreguero <[email protected]>
neutrons · Jul 23, 2024 · f109ff8 · f109ff8
1 parent 5cced0e
commit f109ff8
Show file tree

Hide file tree

Showing 21 changed files with 82 additions and 57 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/dev-docs/Makefile → docs/Makefile b/dev-docs/Makefile → docs/Makefile
diff --git a/dev-docs/conf.py → docs/conf.py b/dev-docs/conf.py → docs/conf.py
diff --git a/dev-docs/README.txt → docs/developer/README.txt b/dev-docs/README.txt → docs/developer/README.txt
diff --git a/dev-docs/images/pycharm_1.png → docs/developer/images/pycharm_1.png b/dev-docs/images/pycharm_1.png → docs/developer/images/pycharm_1.png
diff --git a/dev-docs/index.rst → docs/developer/index.rst b/dev-docs/index.rst → docs/developer/index.rst
diff --git a/dev-docs/pycharm.rst → docs/developer/pycharm.rst b/dev-docs/pycharm.rst → docs/developer/pycharm.rst
diff --git a/dev-docs/testing.rst → docs/developer/testing.rst b/dev-docs/testing.rst → docs/developer/testing.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,34 @@
+.. _refred:
+
+Wellcome to RefRed documentation
+================================
+
+RefRed is a desktop Application for data reduction collected at the SNS Liquids Reflectometer beamline.
+
+User Guide
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /user/load-template
+   /user/compute-scaling-factors
+   /user/reduce-data
+   /user/use-case-list
+
+Developer Guide
+---------------
+
+.. toctree::
+   :maxdepth: 1
+
+   /developer/index
+
+
+Release Notes
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+   release_notes
diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -0,0 +1,48 @@
+.. _release_notes:
+
+Release Notes
+=============
+
+<Next Release>
+--------------
+(date of release)
+
+**Of interest to the User**:
+
+- MR #XYZ: one-liner description
+
+**Of interest to the Developer:**
+
+- MR #XYZ: one-liner description
+
+5.1.0
+-----
+2024-07-16
+
+**Of interest to the User**:
+
+- MR #XYZ: one-liner description
+
+**Of interest to the Developer:**
+
+- MR #XYZ: one-liner description
+
+5.0.0
+-----
+2023-04-01
+
+RefRed v5 now uses a new reduction package <https://github.com/neutrons/LiquidsReflectometer>.
+Apart from being an event-based implementation of the same reduction process,
+the main difference with previous version is the addition of a gravity correction
+and the use of an effective sample-to-detector distance that takes into account
+the average emission time of neutrons in the moderator.
+
+Other changes to version 5 include:
+
+- The normalization option (which is a global option in the current UI) was ignored. It's now also saved properly.
+- The boolean options in the config file were ignored because they were not loaded properly.
+- The table headers on the main page were missing.
+- The Settings panel is no longer useful and has been hidden until we refactor the configuration.
+- A typo made the background subtraction option default to true.
+- Scaling to a Q region under Q_c now works for any Q range. It used to apply only to the first run.
+
diff --git a/docs/compute-scaling-factors.rst → docs/user/compute-scaling-factors.rst b/docs/compute-scaling-factors.rst → docs/user/compute-scaling-factors.rst
diff --git a/docs/data/REFL_188298_reduced_data.txt → docs/user/data/REFL_188298_reduced_data.txt b/docs/data/REFL_188298_reduced_data.txt → docs/user/data/REFL_188298_reduced_data.txt
diff --git a/docs/data/sf-test.cfg → docs/user/data/sf-test.cfg b/docs/data/sf-test.cfg → docs/user/data/sf-test.cfg
diff --git a/docs/load-template.rst → docs/user/load-template.rst b/docs/load-template.rst → docs/user/load-template.rst
diff --git a/docs/reduce-data.rst → docs/user/reduce-data.rst b/docs/reduce-data.rst → docs/user/reduce-data.rst
diff --git a/docs/reduction-results.png → docs/user/reduction-results.png b/docs/reduction-results.png → docs/user/reduction-results.png
diff --git a/docs/refred-load-template.png → docs/user/refred-load-template.png b/docs/refred-load-template.png → docs/user/refred-load-template.png
diff --git a/docs/sf-calculator.png → docs/user/sf-calculator.png b/docs/sf-calculator.png → docs/user/sf-calculator.png
diff --git a/docs/template-inspection.png → docs/user/template-inspection.png b/docs/template-inspection.png → docs/user/template-inspection.png
diff --git a/docs/use-case-list.rst → docs/user/use-case-list.rst b/docs/use-case-list.rst → docs/user/use-case-list.rst
diff --git a/release_notes.md b/release_notes.md