docs updated with newer version of requirements

README.md

@@ -2,7 +2,7 @@
 Hyspecppt
 ==========
 
-Hyspec Polarization tool for Single Crystal and Powder
+Tool that enables users to analyze polarized neutron experiments on powder and single crystal samples using the HYSPEC instrument.
 
 ## Installation Process
 

docs/source/design/hyspecpptfields.rst

@@ -7,56 +7,65 @@ Fields and Validation for Plot
 The main functionality of the tool is to display a plot, based on the filled in parameters, automatically; no plot button exists
 
 Overall, users can:
-   * plot from Powder
-   * plot from Single Crystal
+   * plot from Powder sample
+   * plot from Single Crystal sample
+   * switch between Powder and Single Crystal modes while keeping the previous valid state
    * click on "Help" button that opens up a readthedocs user documentation
 
 Fields
 --------
 
-Below are the fields of SingleCrystal and Powder Models
+Below are the fields of SingleCrystal and Powder sample Models
 
 .. list-table:: Common Fields
   :header-rows: 1
 
   * - Field
     - Type
     - Value Origin
+    - Default
     - Additional validation
     - Mandatory
   * - Polarization Type
     - String
-    - predefined choices:["Powder", "Single Crystal"]
+    - predefined choices:[Powder, Single Crystal]
+    - Powder
     -
     - yes
   * - Ei (Incident Energy) - meV
     - Double
     -
-    - 1 < Ei < 100
+    - 20
+    - 0 < Ei < 100
     - yes
   * - S2 (HYSPEC Detector Tank Angle)
-    - String
-    -
-    - 30<=P<=90
+    - Double
+    - 
+    - 30
+    - -100 < S2< 100 && (S2 > 30 || S2 < -30)
     - yes
-  * - P (Polarization Direction Angle)
+  * - Ap (Polarization Direction Angle)
     - Double
     -
-    - -90<=P<=90
+    - 0
+    - -180 < Ap < 180
     - yes
   * - Delta E
     - Double
     -
+    - 0 (for Power mode)
     - Ei - DeltaE ≥ -Ei
     - no
   * - mod Q (\|Q\|)
     - Double
     -
-    -
+    - 0 (for Power mode)
+    - 0 <= \|Q\| <=10
     - no
   * - Plot Type
     - String
-    - predefined choices:["cos^2(alpha)", "(1+cos^2alpha)/2"]
+    - predefined choices: :math:`[ \alpha_s, \cos^2(\alpha_s),  (1+\cos^2(\alpha_s))/2 ]`
+    - :math:`\cos^2(\alpha_s)`
     -
     - yes
 
@@ -74,48 +83,48 @@ Below are the additional fields of SingleCrystal Model
     - Mandatory
   * - a
     - Double
-    -
+    - 1
     - 1 < a < 100
     - yes
   * - b
     - Double
-    -
+    - 1
     - 1 < b < 100
     - yes
   * - c
     - Double
-    -
+    - 1
     - 1 < c < 100
     - yes
   * - alpha
     - Double
-    -
-    - 45 < alpha < 135
+    - 90
+    - 30 < alpha < 150
     - yes
   * - beta
     - Double
-    -
-    - 45 < beta < 135
+    - 90
+    - 30 < beta < 150
     - yes
   * - gamma
     - Double
-    -
-    - 45 < gamma < 135
+    - 90
+    - 30 < gamma < 150
     - yes
   * - H
     - Double
-    -
-    -
+    - 0
+    - -100 < H < 100
     - yes
   * - K
     - Double
-    -
-    -
+    - 0
+    - -100 < K < 100
     - yes
   * - L
     - Double
-    -
-    -
+    - 0
+    - -100 < L < 100
     - yes
 
 

docs/source/index.rst

@@ -1,16 +1,19 @@
 .. Purpose: The root document of the project, which serves as welcome page and contains the root
 .. of the "table of contents tree" (or toctree).
 
+==========
 Hyspecppt
 ==========
 
+**Hyspec P**\ olarization **P**\ lanning **T**\ ool for Single Crystal and Powder samples
+
+Tool that enables users to analyze polarized neutron experiments on powder and single crystal samples using the HYSPEC instrument.
 
 .. note::
 
    This project is under active development.
 
 
-Hyspec Polarization tool for Single Crystal and Powder
 
 +++++++++++++
 Installation