@@ -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
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: