The FireCARES application

A quick way to get started is with Vagrant and VirtualBox.

• Ansible
• Vagrant
• VirtualBox

git clone https://github.com/FireCARES/firecares.git
git clone https://github.com/FireCARES/firecares-ansible.git
cd firecares-ansible
vagrant up

Wait a few minutes for the magic to happen. Access the app by going to this URL: http://192.168.33.15

When you install FireCARES using Vagrant, the default configuration will restart the Gunicorn process on every request so your server-side modifications should immediately show up.

For client-side changes, you currently need to manually run the collectstatic in order to update the static assets. You can run collect static from the firecares-ansible directory on the host machine using the following command:

ansible-playbook vagrant.yml -i vagrant_server --tags django.collectstatic

To make tileserver changes, see the Prominent Edge tessera-ansible repository, specifically the firecares branch

We use pre-commit, see how to install in your local repository.

You'll need the following commands to run all of the unit tests. Tests are run on each commit automatically, so please run them yourself before you commit.

vagrant ssh
sudo su firecares
workon firecares
python manage.py test

Additionally, individual tests can be run using the full module/classname/test name path. If not testing migrations --keepdb will significantly speed up the whole process:

python manage.py test firecares.firestation.tests.test_metrics:FireDepartmentMetricsTests.test_calculate_structure_counts --noinput --keepdb

This project uses LESS CSS pre-processor to generate CSS rules. To make a modification to a CSS rule, follow these steps:

1. Make the modification in the appropriate LESS file. For example: style.less
2. Use the lessc command to compile the CSS from LESS and pipe the output to the appropriate location lessc style.less > ../css/style.css.

To assist in the transparency of the calculations and data analysis, ipython notebooks in the /scripts folder can be run from your vagrant machine via:

ssh -L 8888:localhost:8888 vagrant@192.168.33.15
sudo chmod a+rwx /run/user/1000
sudo su firecares
workon firecares
python manage.py shell_plus --notebook --no-browser  # follow the instructions that follow in your shell regarding logging into ipython with a token

When developing client-side functionality for FireCARES it is often helpful to symlink client-side assets so they refresh when the browser is refreshed.

vagrant ssh
sudo sed -i '/location \/static/a sendfile off;' /etc/nginx/sites-enabled/firecares
sudo service nginx restart
sudo su firecares
workon firecares
python manage.py collectstatic --noinput -l --clear

In order to test the osgeo_importer functionality within FireCARES, specifically being able to step via debugger into specific celery processes, you will need to ensure that CELERY_ALWAYS_EAGER = True; however, this will not yield a resulting task state other than PENDING so items that depend on a celery result will never finish (eg. the osgeo upload dialog will never close on its own). Additionally, in order to support a multi-node deployment, celery results are stored using the memcached backend and the actual uploaded file is pushed/pulled to/from an S3 bucket as specified by OSGEO_STORAGE_BUCKET_NAME before being acted-upon by GDAL, but specifying a bucket name is not necessary for local development as the FireCARES importer and inspector can handle these tasks using a local filesystem.