diff --git a/AcquisitionDeviceRun_SeqDiagram.png b/AcquisitionDeviceRun_SeqDiagram.png new file mode 100644 index 000000000..7251c326f Binary files /dev/null and b/AcquisitionDeviceRun_SeqDiagram.png differ diff --git a/MalcolmDevice_ClassDiagram.png b/MalcolmDevice_ClassDiagram.png new file mode 100644 index 000000000..981c81fe7 Binary files /dev/null and b/MalcolmDevice_ClassDiagram.png differ diff --git a/NewScanning_ClassDiagram.png b/NewScanning_ClassDiagram.png new file mode 100644 index 000000000..95aea6208 Binary files /dev/null and b/NewScanning_ClassDiagram.png differ diff --git a/README.md b/README.md index 53aa28895..2f180d356 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,19 @@ Example: [org.eclipse.scanning.test.points.Suite](https://github.com/eclipse/sca 5. After setting this target as the target platform, your code should compile 6. Start an apachemq on localhost:61616 7. Run the example server and example client and go to the 'X-Ray Centering' example erspective or the 'Scanning' perspective. + +# Where is Scanning Used + +Currently the scanning project is used as part of [Generic Data Acquisition](http://www.opengda.org/) for certain scan types, those linked to NeXus writing, layered scans and mapping including [Malcolm Devices](https://alfred.diamond.ac.uk/documentation/manuals/GDA_Developer_Guide/master/malcolm.html#use-of-malcolm-in-new-style-scanning). You can read more about how the scanning project is used at + [Mapping and Solstice Scanning](https://alfred.diamond.ac.uk/documentation/manuals/GDA_Developer_Guide/master/use_cases.html#use-case-new-style-solstice). [Diamond Light Source Ltd.](http://diamond.ac.uk/) produce their own Java API for the scanning library [javadocs here](https://alfred.diamond.ac.uk/documentation/javadocs/GDA/master/org/eclipse/scanning/api/package-summary.html) . + + +* Class Diagram of core scanning components: +[![Scanning Classes](./NewScanning_ClassDiagram.png)](https://alfred.diamond.ac.uk/documentation/manuals/GDA_Developer_Guide/master/use_cases.html#use-case-new-style-solstice) + +* Sequence Diagram +![Sequence Diagram](./AcquisitionDeviceRun_SeqDiagram.png) + +* Class Diagram Malcolm +[![Malcolm Classes Scanning](./MalcolmDevice_ClassDiagram.png)](https://alfred.diamond.ac.uk/documentation/manuals/GDA_Developer_Guide/master/_images/MalcolmDevice_ClassDiagram.png) +