Merge pull request CodeForPhilly#7 from brandonfcohen1/main

Merge BC updates to python scripts

.gitignore

@@ -1,2 +1,4 @@
 /notebooks/.ipynb_checkpoints/
 .idea
+src/tmp
+.DS_Store

Pipfile

@@ -15,6 +15,10 @@ scikit-learn = "*"
 mapclassify = "*"
 black = "*"
 fiona = "*"
+esridump = "*"
+sqlalchemy = "*"
+psycopg2-binary = "*"
+geoalchemy2 = "*"
 
 [dev-packages]
 

README.md

@@ -36,17 +36,38 @@ In September, we hope to begin turning our attention to building the dashboard a
 - Tailwind
 - Python (data engineering)
 
+
 # Setup Instructions
+
 1. Install [pyenv](https://github.com/pyenv/pyenv) (or [pyenv-win](https://github.com/pyenv-win/pyenv-win) for Windows) for Python version management
 2. Install the latest Python 3.11: `pyenv install 3.11.4`
 3. Install [pipenv](https://github.com/pypa/pipenv) for environment management
 4. Install project requirements: `pipenv install`
 
+# Database
+
+1. Make sure postgres and postgis are installed
+   TODO: Add instructions here
+2. Create a new databse
+   `createdb vacantlotdb`
+3. Connect to the db
+   `psql vacantlotdb`
+4. Enable postgis
+   `CREATE EXTENSION postgis;`
+5. Set your database connection string to an environment variable `VACANT_LOTS_DB`
+
+# awkde
+
+We are using the [awkde package](https://github.com/mennthor/awkde) to create the Adaptive Width KDE. It is not available through pip. Install directly in the `src` folder using their instructions.
+
 # Usage Instructions
+
 1. Activate the pipenv shell: `pipenv shell`
-2. Run the main script: `python process_data.py [output_filename]`
+2. Move the to src folder `cd src`
+3. Run the main script `python script.py`
 
 # Contribution Instructions
+
 1. Create a fork of this repository and work from branches within your fork. When those changes are ready for review, create a pull request from fork:branch to upstream:main
 2. Before committing changes, format your code to maintain a consistent codebase: 
     ```