Skip to content

Commit 946ebef

Browse files
Update README.md
1 parent 451cd54 commit 946ebef

File tree

1 file changed

+41
-21
lines changed

1 file changed

+41
-21
lines changed

README.md

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
1-
# Python_GUI_apps
2-
GUI Python apps
1+
# GLabViz
2+
GUI Python apps written in qt and python for quick analysis of custom data. It also includes the ability to convert data to *H5* if need to be analysed in other software such as MATLAB.
33

4-
## Dependencies
5-
- scopefoundry
6-
- numpy
7-
- pyqt
8-
- qtpy
9-
- h5py
10-
- pyqtgraph
11-
- matplotlib
12-
- scipy
13-
- lmfit
14-
- customplotting
4+
*Python is not required to use GLabViz* (see *How to use?*)
155

16-
## Installing dependencies from command-line
6+
The primary users for this Python package are Ginger Lab members at the University of Washington, Seattle but is licensed under MIT License and open for everyone to use.
7+
8+
## Includes
9+
* Fluorescence Lifetime Analysis
10+
* Spectra Analysis
11+
* Fluorescence Lifetime Imaging Microscopy (FLIM) Data Analysis
12+
* Photluminescence Quantum Efficiency (PLQE) Analysis
13+
* UV-Vis Data Analysis
14+
* General *H5* View and Plot
15+
* *H5* and *PKL* File Viewer
16+
17+
## How to use?
18+
### Without installing Python or any dependencies
19+
* Under the releases page, download the latest release of the _*DataBrowser*_ zip file
20+
* Extract the zip file and run *DataBrowser.exe*
21+
### With Python and its dependencies
1722
```
18-
conda install numpy pyqt qtpy h5py pyqtgraph
19-
pip install git+git://github.com/ScopeFoundry/ScopeFoundry.git
20-
pip install matplotlib scipy lmfit customplotting==0.1.4.dev0
23+
git clone https://github.com/SarthakJariwala/Python_GUI_apps.git
2124
```
22-
23-
## Run instructions
24-
After setup, you can run the application by double-clicking DataBrowser.py.
25-
You can also run it from command-line while in the PythonGUI_apps folder:
25+
* Run the application by double-clicking DataBrowser.py.
26+
* OR Run it from command-line while in the PythonGUI_apps folder:
2627
```
2728
python DataBrowser.py
2829
```
30+
31+
#### Dependencies
32+
* ScopeFoundry
33+
* pyqtgraph
34+
* numpy
35+
* pyqt
36+
* qtpy
37+
* h5py
38+
* matplotlib
39+
* scipy
40+
* lmfit
41+
* customplotting
42+
43+
#### Installing dependencies from command-line
44+
```
45+
conda install numpy pyqt qtpy h5py pyqtgraph
46+
pip install ScopeFoundry
47+
pip install matplotlib scipy lmfit customplotting==0.1.4.dev0
48+
```

0 commit comments

Comments
 (0)