Rename tool everywhere

.github/workflows/hyspecplanningtools.yml → .github/workflows/hyspecppt.yml

@@ -21,15 +21,14 @@ jobs:
           channels: conda-forge,defaults
           use-mamba: true
           environment-file: environment.yml
-          activate-environment: hyspecplanningtools_dev
       - name: build conda package
         run: |
           # set up environment
           cd conda.recipe
           echo "versioningit $(versioningit ../)"
           # build the package
           VERSION=$(versioningit ../) conda mambabuild --channel conda-forge --output-folder . .
-          conda verify noarch/hyspecplanningtools*.tar.bz2
+          conda verify noarch/hyspecppt*.tar.bz2
       - name: upload conda package to anaconda
         shell: bash -l {0}
         if: startsWith(github.ref, 'refs/tags/v')
@@ -41,7 +40,7 @@ jobs:
           CONDA_LABEL="main"
           if [ "${IS_RC}" = "true" ]; then CONDA_LABEL="rc"; fi
           echo pushing ${{ github.ref }} with label $CONDA_LABEL
-          anaconda upload --label $CONDA_LABEL conda.recipe/noarch/hyspecplanningtools*.tar.bz2
+          anaconda upload --label $CONDA_LABEL conda.recipe/noarch/hyspecppt*.tar.bz2
 
   pypi-publish:
     name: upload release to PyPI
@@ -60,7 +59,6 @@ jobs:
           channels: conda-forge,defaults
           use-mamba: true
           environment-file: environment.yml
-          activate-environment: hyspecplanningtools_dev
       - name: build pypi package
         run: |
           # build the package

.github/workflows/unittest.yml

@@ -42,7 +42,7 @@ jobs:
         run: |
           # test that the python wheel builds
           VERSION=$(versioningit .) python -m build --wheel --no-isolation
-          twine check dist/hyspecplanningtools-*.whl
+          twine check dist/hyspecppt-*.whl
       - name: build conda package
         run: |
           # test that the conda package builds
@@ -52,4 +52,4 @@ jobs:
           # below to build the conda package in your local machine
           CHANNELS="--channel conda-forge"
           VERSION=$(versioningit ../) conda mambabuild $CHANNELS --output-folder . .
-          conda verify noarch/hyspecplanningtools*.tar.bz2
+          conda verify noarch/hyspecppt*.tar.bz2

.gitignore

@@ -26,7 +26,8 @@ share/python-wheels/
 *.egg
 MANIFEST
 _version.py
-
+conda.recipe/
+!conda.recipe/meta.yaml
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

.readthedocs.yaml

@@ -5,9 +5,14 @@ build:
   tools:
     python: "mambaforge-22.9"
 
+python:
+  install:
+    - method: pip
+      path: .
+
 sphinx:
   builder: html
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
   fail_on_warning: true
 
 conda:

README.md

@@ -1,8 +1,8 @@
 
-HyspecPlanningTools
-=====================
+Hyspecppt
+==========
 
-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
 
@@ -12,16 +12,16 @@ Create the development conda environment
 
 Activate the environment
 
-`conda activate hyspecplanningtools_dev`
+`conda activate hyspecppt_dev`
 
 Install the application in editable mode
 
 `pip install -e .`
 
 Start the tool
 
-`hyspecplanningtools`
+`hyspecppt`
 
 
-[![CI](https://github.com/neutrons/HyspecPlanningTools/actions/workflows/unittest.yml/badge.svg?branch=next)](https://github.com/neutrons/HyspecPlanningTools/actions/workflows/unittest.yml)
-[![codecov](https://codecov.io/gh/neutrons/HyspecPlanningTools/graph/badge.svg?token=GAQE3SS0HJ)](https://codecov.io/gh/neutrons/HyspecPlanningTools)
+[![CI](https://github.com/neutrons/hyspecppt/actions/workflows/unittest.yml/badge.svg?branch=next)](https://github.com/neutrons/hyspecppt/actions/workflows/unittest.yml)
+[![codecov](https://codecov.io/gh/neutrons/hyspecppt/graph/badge.svg?token=GAQE3SS0HJ)](https://codecov.io/gh/neutrons/hyspecppt)

conda.recipe/meta.yaml

@@ -12,7 +12,7 @@
 {% set build_number = 0 %}
 
 package:
-  name: hyspecplanningtools
+  name: hyspecppt
   version: {{ version_number }}
 
 source:

docs/source/conf.py

@@ -14,7 +14,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "Hyspecplanningtools"
+project = "Hyspecppt"
 copyright = "2024, ORNL"  # noqa A001
 author = "ORNL"
 # version = versioningit.get_version("../../")

docs/source/design/polarizationmodel.rst → docs/source/design/hyspecpptclasses.rst

@@ -1,21 +1,21 @@
-.. _polmodel:
+.. _hyspecpptclasses:
 
-Design
-=======
+Model-View-Presenter
+=====================
 
 
 
-PPT Model
--------------------
+HyspecPPT Model
+----------------
 
 .. mermaid::
 
  classDiagram
-    PPTModel <|-- SingleCrystalModel
-    PPTModel <|-- PowderModel
+    HyspecPPTModel <|-- SingleCrystalModel
+    HyspecPPTModel <|-- PowderModel
 
 
-    class PPTModel{
+    class HyspecPPTModel{
         <<Abstract>>
         +Double incident_energy_e
         +Double detector_tank_angle_s
@@ -24,6 +24,8 @@ PPT Model
         +Double mod_q
         +Option graph_type
         +calculate_graph_data()
+        +get_model_data()
+        +store_data()
 
     }
 
@@ -38,6 +40,7 @@ PPT Model
         +String single_crystal_k
         +String single_crystal_l
         +calculate_qmod()
+        +get_single_crystal_data()
     }
 
     class PowderModel{
@@ -46,15 +49,15 @@ PPT Model
 
 
 
-PPT View
--------------------
+HyspecPPT View
+---------------
 
 .. mermaid::
 
  classDiagram
-    PPTWindow "1" -->"1" SingleCrystalParameters
+    HyspecPPTView "1" -->"1" SingleCrystalParameters
 
-    class PPTWindow{
+    class HyspecPPTView{
         -Signal~str~:error_message_signal
         -Signal~str~:update
 
@@ -78,7 +81,8 @@ PPT View
         +send_error_message()
         -show_error_message()
         //+QStatusBar:status_bar
-        +update_plot()
+        +get_stored_data()
+        +store_data_and_update_plot()
         +show_hide_cystal_parameters()
         +validate_delta_ei()
     }
@@ -109,26 +113,26 @@ PPT View
     }
 
 
-PPT Presenter
------------------------
+HyspecPPT Presenter
+--------------------
 
 .. mermaid::
 
  classDiagram
-    PPTPresenter "1" -->"1" PPTModel
-    PPTPresenter "1" -->"1" PPTWindow
+    HyspecPPTPresenter "1" -->"1" HyspecPPTModel
+    HyspecPPTPresenter "1" -->"1" HyspecPPTView
 
-    class PPTPresenter{
-        -PPTModel:model
-        -PPTWindow:view
+    class HyspecPPTPresenter{
+        -HyspecPPTModel:model
+        -HyspecPPTView:view
         +update_plot()
         +update_qmod()
     }
 
-    class PPTModel{
-        <from above>
+    class HyspecPPTModel{
+        #from above
     }
 
-    class PPTWindow{
-        <from above>
+    class HyspecPPTView{
+        #from above
     }