License

Author: szwieback

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Simon Zwieback
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,28 @@
+# closig
+
+Temporal closure signatures from interferometric covariance matrices. A closure signature is determined using a basis of the annihilator of consistent phases, i.e., a list of linear functionals that measure the deviation from consistency. Bases with meaningful time-timescale characteristics enable extraction of temporal closure signatures that lend themselves to interpretation and comparison to models. 
+
+The key functionalities are:
+* extraction of temporal closure signatures using two complementary bases (small steps and two hops)
+* visualization of closure signatures
+* aggregation of closure signatures in time and space
+* phase linking comparison experiments; phase linking functionality is provided through the greg package
+* modeled closure signatures from simple interferometric scattering models
+
+The code is modular to support scientific inquiries but is inefficient. It is not intended for large-scale processing.
+
+## Requirements
+
+Tested on Python 3.10.4, with numpy 1.22.3, matplotlib, abc, pickle, zlib. The greg package is needed for phase linking.
+
+## Contact
+
+[Simon Zwieback](https://szwieback.github.io)
+[Rowan Biessel](https://github.com/rbiessel)
+
+Feedback, ideas and contributions are greatly appreciated.
+
+## License
+
+This project is licensed under the MIT license.
+