Merging of the different branches focused on simulations and real measurements

README.md

@@ -1,10 +1,37 @@
 # pySC
-Python Simulated Commissioning toolkit for synchrotrons, inspired by [SC](https://github.com/ThorstenHellert/SC) which is written in Matlab.
+
+Python Simulated Commissioning toolkit for synchrotrons.
 
 ## Installing
 
 ```bash
-git clone https://github.com/kparasch/pySC
-cd pySC
-pip install -e .
+pip install accelerator-commissioning
 ```
+
+## Importing specific modules
+
+Intended way of importing a pySC functionality:
+
+```
+from pySC import SimulatedCommissioning
+from pySC import generate_SC
+
+from pySC import ResponseMatrix
+
+from pySC import orbit_correction
+from pySC import measure_bba
+from pySC import measure_ORM
+from pySC import measure_dispersion
+
+from pySC import pySCInjectionInterface
+from pySC import pySCOrbitInterface
+
+# the following disables rich progress bars (doesn't work well with )
+from pySC import disable_pySC_rich
+disable_pySC_rich()
+```
+
+
+## Acknowledgements
+
+This toolkit was inspired by [SC](https://github.com/ThorstenHellert/SC) which is written in Matlab.

pySC/__init__.py

@@ -6,26 +6,43 @@
 
 """
 
-__version__ = "0.4.5"
+__version__ = "1.0.0"
 
-from .core.new_simulated_commissioning import SimulatedCommissioning
+from .core.simulated_commissioning import SimulatedCommissioning
 from .configuration.generation import generate_SC
-from .tuning.response_matrix import ResponseMatrix
-
+from .apps.response_matrix import ResponseMatrix
+from .apps.measurements import orbit_correction
+from .apps.measurements import measure_bba
+from .apps.measurements import measure_ORM
+from .apps.measurements import measure_dispersion
+from .tuning.pySC_interface import pySCInjectionInterface, pySCOrbitInterface
 import logging
 import sys
 
 logging.basicConfig(
     #format='%(asctime)s.%(msecs)03d:%(levelname)s:%(name)s:\t%(message)s',
     format="{asctime} | {levelname} | {message}",
-    datefmt="%d %b% %Y, %H:%M:%S",
+    datefmt="%d %b %Y, %H:%M:%S",
     level=logging.INFO,
     style='{',
     stream=sys.stdout
 )
 
 def disable_pySC_rich():
-    from .tuning import response_measurements
     from .apps import response
-    response_measurements.DISABLE_RICH = True
     response.DISABLE_RICH = True
+
+# This is needed to avoid circular imports.
+# Firstly the type of SC is hinted to avoid importing SimulatedCommissioning:
+#   class pySCOrbitInterface(AbstractInterface):
+#      SC: "SimulatedCommissioning" = Field(repr=False)
+#
+# Then, the model_rebuild is triggered here to complete the pydantic model,
+# and allow validation.
+# for this to be triggered, one needs to import pySC or to import from pySC
+# (i.e. from pySC import ...)
+# to validate a pySCInjectionInterface/pySCOrbitInterface object, one should
+# already have a SimulatedCommissioning object. To acquire the SimulatedCommissioning,
+# the model_rebuild is "almost certainly"? triggered.
+pySCInjectionInterface.model_rebuild()
+pySCOrbitInterface.model_rebuild()