Merge remote-tracking branch 'origin/master'

README.md

@@ -1,3 +1,31 @@
+# Full SMS
+
+An analysis suite developed by the Biophysics Group at the University of Pretoria, South Africa.
+
+### Main Features
+
+- Performs change point analysis to resolve intensity levels of fluorescence measurements
+- Uses Agglomerative Hierarchical Clustering to group resolved levels
+- Performs fluorescence decay fitting to measure lifetimes
+
+### Known limitations/problems
+
+- Inability to close measurement file once opened
+- Some systems may encounter missing numxpr module
+
+### Planned Improvements
+
+- Global Grouping
+- Improved stability
+- Additional conversion tools
+
+### Additional Info
+
+An example file can be downloaded here:
+https://rb.gy/wtzg0z
+
+A detailed explanation of the HDF5 format used will still be provided in the near future. In the mean time the HDF5 Viewer can be downloaded from the HDF Group website by creating a free account, and the example file can be inspected.
+
 This software is to be used only if reference is made to the following paper:
 
 Kyeyune, F., Botha, J.L., Van Heerden, B., Malý, P., Van Grondelle, R., Diale, M. and Krüger, T.P., 2019. Strong plasmonic fluorescence enhancement of individual plant light-harvesting complexes. Nanoscale, 11(32), pp.15139-15146.