reneaunc / trivialcompute

trivial compute skeleton

DEVELOPMENT WORK IN PROGRESS

NO WHEEL FILE OR INIT.PY

=======Required========
-git
-python 3.1 or higher
-pygame
-cairo

=======To setup a run time environment========
1.) get the latest python distrib: https://www.python.org/downloads/
2.) install git: https://www.git-scm.com/book/en/v2/Getting-Started-Installing-Git
3.) install python
4.) clone this repo to wherever you'd like
5.) setup a python virtual environment
- open a terminal or command prompt to the TOP LEVEL of your wherever you cloned the repo
- run the following: "python -m venv env"
- a folder should be created at the top of your repo named env, the git ignore is tracked to ignore this
6.) activate your virtual environment in a terminal
- env\Scripts\activate
7.) install pygame
- (from your venv terminal) pip install pygame
8.) install cairo
- (from your venv terminal) pip install pycairo
9.) install numpy
- (from your venv terminal) pip install numpy
10.) install psycopg2
- (from your venv terminal) pip install psycopg2-binary
11.) install cv2
- (from your venv terminal) pip install opencv-python
12.) install pillow
- (from your venv terminal) pip install pillow

=======Running========
(from your venv terminal) python src/main.py

NOTE: IF you are trying to run the online multiplayer component, you need to first do:
python src/network/server.py this will convert your terminal into a server

Now you can run
python src/main.py

and as many instances (up to 4) as you'd like

Database setup
======================================
Download PostgreSQL (This will install pgAdmin 4 as well)
https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

password: postgres
port: 5432
locale: Default locale

Open pgAdmin 4
Create a database with the following:

Host name/address: localhost
Port: 5432
Username: postgres
Password: postgres
database name: trivialCompute

Run the table creation scripts: run scripts 1 - 3 in the scripts folder

macOS setup python virtual environment
======================================
Source: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/

1. python3.10 -m venv .venv (create new virtual environemnt)
   
2. source .venv/bin/activate (activate virtual environment)
   
3. which python (to confirm)