This repo stores the code necessary to generate experimental reports explaining how the CCAO Data team's residential model valued any particular single-family home or multifamily home with six or fewer units.
This project expects that you have the Hugo CLI installed on your machine.
Note
While the Data team often does work on the server, you should do Hugo
development on your laptop in order to run the development site. Hugo
installation is easiest using WSL, where you can install it by running
sudo snap install hugo and entering your WSL user password. Your WSL
password will most likely be different from your laptop password; if
you're having trouble authenticating, reach out to a senior staff member
for help.
- Ensure that Hugo is installed correctly by running
hugo version. - Navigate to the
hugo/subdirectory and run the development server:
cd hugo
hugo serve
- Any reports that you have generated will be available in a browser at http://localhost:1313/.
You can use the generate_homeval
script
to generate reports that you can view locally.
Start by creating a virtual environment for the script and installing its dependencies:
uv venv scripts/generate_homeval/.venv
source scripts/generate_homeval/.venv/bin/activate
uv pip install scripts/generate_homeval
Then, use the script to generate reports for one or more PINs using a given comps run ID:
AWS_ATHENA_S3_STAGING_DIR="<your_athena_staging_dir>" python3 scripts/generate_homeval/generate_homeval.py \
--run-id <your_comps_run_id> \
--pin <one_or_more_space_separated_pins>
Run python3 scripts/generate_homeval/generate_homeval.py --help to see full
documentation for the script.
We manage deployments using the generate-homeval GitHub
workflow.
That workflow includes options for deploying to a development environment as
well as the production environment.