Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #18

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,23 @@ Bleeding edge development snapshots are available! These are built continiously,
You can also build/run it yourself. You need the following:
* Python 3 and the following Python packages
* OpenCV (opencv-python)
* NumPy
* NumPy (Use version 2.0.2, August 2024 released 2.1.2 and it breaks PCSI)
* ImageIO
* BitString
* BitString (Use version 4.1.4, April 2024 released 4.2 and it breaks PCSI)
* PyLBFGS (includes pre-built [liblbfgs](https://github.com/chokkan/liblbfgs))
* PySerial
* Pillow
* PyInstaller (optional, if you want to build executable files)

These can all be installed using `python3 -m pip install opencv-python numpy imageio bitstring pylbfgs pyserial pillow`
These can all be installed using `python3 -m pip install opencv-python numpy==2.0.2 imageio bitstring==4.1.4 pylbfgs pyserial pillow`

### KD9YQK Linux Instructions
1. Clone the repo to home directory
2. Create a virtual environment. We need to install older packages and dont want them system-wide. ` python -m venv PCSI/`
3. Enter the PCSI directory and type `source bin/activate` to activate the environment.
4. install all the required python modules `python3 -m pip install opencv-python numpy==2.0.2 imageio bitstring==4.1.4 pylbfgs pyserial pillow`
5. `python pcsiGUI.py` to start. `deactivate` to close the virtual environment and return to shell.
6. To run without manually running the venv, use `~/PCSI/bin/python ~/PCSI/pcsiGUI.py`

### Linux and MacOS build instructions
1. You probably already have python installed. If not, install python version 3 from your distribution (e.g., `apt`), (Python.org), or Anaconda.
Expand Down