Skip to content
Snippets Groups Projects
Commit 9edf3d59 authored by Dario Barghini's avatar Dario Barghini
Browse files

Update README.md

parent e4051859
No related branches found
No related tags found
No related merge requests found
...@@ -17,7 +17,7 @@ The initial port to Python3 has been done by Anthony Tekatch (Unihedron). ...@@ -17,7 +17,7 @@ The initial port to Python3 has been done by Anthony Tekatch (Unihedron).
### Setup ### Setup
After downloading the software, you need to modify the file `config.py`(config.py). After downloading the software, you need to modify the file [`config.py`](config.py).
In this file you will find several variables that need to be configured to match your hardware settings. In this file you will find several variables that need to be configured to match your hardware settings.
For example: For example:
...@@ -31,7 +31,7 @@ Remember that python (2.7) syntax is mandatory in this file ...@@ -31,7 +31,7 @@ Remember that python (2.7) syntax is mandatory in this file
### How to use the software ### How to use the software
After configuring the software, make sure you are in the parent directory were the `README.md`, `LICENSE.txt` and `MANIFEST.in` files are located After configuring the software, make sure you are in the parent directory were the [`README.md`](README.md), [`LICENSE`](LICENSE) and [`MANIFEST.in`](MANIFEST.in) files are located
``` ```
> ls > ls
LICENSE.txt MANIFEST.in README.md pysqm config.py setup.py LICENSE.txt MANIFEST.in README.md pysqm config.py setup.py
...@@ -44,7 +44,8 @@ And then run the software: ...@@ -44,7 +44,8 @@ And then run the software:
The program should find your SQM device and the data adquisition will start (if it's night-time). The program should find your SQM device and the data adquisition will start (if it's night-time).
Note: running the `setup.py` script is neither tested nor required. The program is currently being redesigned as a normal python package, but at present no setup is required. Note: running the [`setup.py`](setup.py) script is neither tested nor required.
The program is currently being redesigned as a normal python package, but at present no setup is required.
### How it works ### How it works
...@@ -57,7 +58,9 @@ Each N measurements, the main program calls a plotting function to generate a gr ...@@ -57,7 +58,9 @@ Each N measurements, the main program calls a plotting function to generate a gr
### PySQM known issues ### PySQM known issues
Non-ASCII characters are not supported in the `config.py` file. Please, avoid using 'ñ', accented vowels, etc. Non-ASCII characters are not supported in the [`config.py`](config.py) file.
Please, avoid using 'ñ', accented vowels, etc.
In headless systems, such as the Raspberry PI, if you run the program without X, you may suffer from the following fatal error when the program tries to generate the plot: In headless systems, such as the Raspberry PI, if you run the program without X, you may suffer from the following fatal error when the program tries to generate the plot:
``` ```
...@@ -66,7 +69,7 @@ Available platform plugins are: eglfs, kms, linuxfb, minimal, minimalegl, offscr ...@@ -66,7 +69,7 @@ Available platform plugins are: eglfs, kms, linuxfb, minimal, minimalegl, offscr
Reinstalling the application may fix this problem. Aborted (core dumped) Reinstalling the application may fix this problem. Aborted (core dumped)
``` ```
In order to avoid this problem, you need to create (or modify if the file exists) in your HOME directory the following file: In order to avoid this problem, you need to create (or modify if the file exists) in your `HOME` directory the following file:
``` ```
> .config/matplotlib/matplotlibrc > .config/matplotlib/matplotlibrc
...@@ -77,7 +80,8 @@ You just need to set the matplotlib backend to Agg: ...@@ -77,7 +80,8 @@ You just need to set the matplotlib backend to Agg:
backend : Agg backend : Agg
``` ```
Save the changes and exit. Now, PySQM should make the plots without issues. You may need to restart PySQM to apply the changes. Save the changes and exit.
Now, PySQM should make the plots without issues. You may need to restart PySQM to apply the changes.
Path to EXE files (windows only): Path to EXE files (windows only):
https://www.dropbox.com/s/xlbr6ktk8spjsse/PySQM.exe?dl=0 https://www.dropbox.com/s/xlbr6ktk8spjsse/PySQM.exe?dl=0
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment