Check all files (important!)

[dboonz]

These are all the files that we should check for documentation and other obvious mistakes. Please pick a file or a directory, mark it here as being taken care of and file an issue with a pull request so we can track that everything has been taken care of. Send @dboonz an email once you're done or write a note in the pull request if you need help.

The docstring should look like:

    def my_function(self, a, b, c=3):
        """ <--- this is the start of the docstring
        Update a based on b. (This is a one-line description)

        A longer explanation goes here maybe including examples and notes and caveats


        Parameters
        ----------
        a: np.ndarray
            the first argument. Should be between 1 and 2
        b: np.ndarray
            The second argument
        c:int
            Are you still reading this?

        Returns
        -------
        nothing
        """  <--- this is the endof the docstring
        pass

Pycharm users: File --> Settings --> Tools --> Python Integrated Tools and you'll spot it immediately. If you want to create a docstring, go to the line under the function definition, type three times ", then enter and it'll pop right up.

Visual studio: https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

1. • ├───example_data
2. • │
3. • ├───example_scripts
4. • │ exampleGridGenerator.py
5. • │ exampleLoader.py
6. • │ examplePreprocess.py
7. • │ exampleReconstructionCPM.py
8. • │ exampleReconstructionFPM.py
9. • │ exampleReconstruction_pcPIE.py
10. • │ preprocess_SHGdata.py
11. • │ simulateData.py
12. • │ simulateData_new.py
13. • │
14. • ├───fracpy.egg-info
15. • │ dependency_links.txt
16. • │ PKG-INFO
17. • │ requires.txt
18. • │ SOURCES.txt
19. • │ top_level.txt
20. • │
21. • └───PtyLab
22. • │ testall.py
23. • │ init.py
24. • │
25. • ├───config
26. • │ init.py
27. • │
28. • ├───Engines
29. • │ │ aPIE.py
30. • │ │ BaseEngine.py
31. • │ │ e3PIE.py
32. • │ │ ePIE.py
33. • │ │ mPIE.py
34. • │ │ mqNewton.py
35. • │ │ multiPIE.py
36. • │ │ pcPIE.py
37. • │ │ qNewton.py
38. • │ │ test_BaseEngine.py
39. • │ │ zPIE.py
40. • │ │ init.py
41. • │ │
42. • │ ├───test
43. • │ │ test_baseReconstructor.py
44. • │ │ test_ePIE.py
45. • │ │ test_propagator.py
46. • │ │ init.py
47. • │
48. • │
49. • ├───ExperimentalData
50. • │ │ ExperimentalData.py
51. • │ │ init.py
52. • │ │
53. • │ ├───test
54. • │ │ test_experimentalData.py
55. • │ │ init.py
56. • [ ]
57. • │
58. • ├───GridGeneration
59. • │ FermatGridGenerator.py
60. • │ init.py
61. • │
62. • ├───io
63. • │ │ readExample.py
64. • │ │ readHdf5.py
65. • │ │ init.py
66. • │ │
67. • │ ├───test
68. • │ │ test_example_loader.py
69. • │ │ test_get_example_data_folder.py
70. • │ │ test_loadInputData.py
71. • │ │ init.py
72. • [ ]
73. • │
74. • ├───Monitor
75. • │ │ Monitor.py
76. • │ │ Plots.py
77. • │ │ README.md
78. • │ │ TensorboardMonitor.py
79. • │ │ test_TensorboardMonitor.py
80. • │ │ init.py
81. • │ │
82. • │ ├───test
83. • │ │ test_matplotlib_monitor.py
84. • │ │ test_TensorboardMonitor.py
85. • │ │ init.py
86. • │ │
87. • [ ]
88. • ├───monitors
89. • │ └───__pycache__
90. • │ .gitignore
91. • │
92. • ├───Operators
93. • │ │ Operators.py
94. • │ │ README.md
95. • │ │ test_Operators.py
96. • │ │ _propagation_kernels.py
97. • │ │ init.py
98. • │ │
99. • │ ├───test
100. • │ │ test_operators.py
101. • │ │ init.py
102. • │ │
103. • │
104. • ├───Params
105. • │ │ Params.py
106. • │ │ init.py
107. • │
108. • │
109. • ├───ProbeEngines
110. • │ OPRP.py
111. • │ StandardProbe.py
112. • │ test_OPRP.py
113. • │ test_StandardProbe.py
114. • │ init.py
115. • │
116. • ├───Reconstruction
117. • │ │ CalibrationFPM.py
118. • │ │ Reconstruction.py
119. • │ │ init.py
120. • │ │
121. • │ ├───test
122. • │ │ test_optimizable.py
123. • │ │ init.py
124. • │ │
125. • │
126. • ├───Regularizers
127. • │ init.py
128. • │
129. • ├───utils
130. • │ │ alignment.py
131. • │ │ gpuUtils.py
132. • │ │ initializationFunctions.py
133. • │ │ scanGrids.py
134. • │ │ utils.py
135. • │ │ visualisation.py
136. • │ │ init.py
137. • │ │
138. • │ ├───test
139. • │ │ test_complexPlot.py
140. • │ │ test_fft2c_ifft2c.py
141. • │ │ init.py