VA Explorer

VA Explorer is a full service verbal autopsy (VA) management reference implementation. It demos VA data management and analysis capabilities while exploring IT challenges in the VA domain. This reference implementation represents a work-in-progress, maturing in response to feedback from users and subject matter experts like in our Zambia pilot program. VA Explorer currently supports the following features:

• User account management and role-based access
• Supervision of users' and facilities' incoming data
• Automatic cause of death assignment via algorithms like InterVA5
• Visualization and analysis dashboard with geography, demographics, trends, etc.
• Ability to detect and correct errors in collected VAs
• Import of VA data and export of processed VA data
• Integrations other tools in the domain such as ODK Central and DHIS2

for more details, see VA Explorer's Features

Background

VAs are a standardized WHO instrument in the form of a structured interview for determining the most likely cause of death based on interview answers. VA Explorer aims to help users of VAs (typically those involved in civil registration and vital statistics) process, manage, and analyze their collected data by integrating other VA IT tools and functionalities behind a single, scalable, shared interface.

Deploy Your Own

VA Explorer instances are easily deployed via docker-compose and web server. Read the guide to learn how to run VA Explorer for yourself or your organization.

Getting Started

Full documentation and training on how to install, configure, deploy and use VA Explorer is available at va-explorer.github.io/va_explorer

The rest of this README focuses on a quick start for contributors. If that applies, thank you. Your contributions are welcome and hugely appreciated. Read on to get started.

Pre-requisites

VA Explorer is built with Django, backed by Postgres, and packaged with Docker so contributors should, at a minimum, install:

• Python 3
• Postgres
• Docker

Setup

1. Clone this repo and change into the new directory

git clone https://github.com/VA-Explorer/va_explorer.git && cd va_explorer

2. Create a project virtual env and activate it

python -m venv venv && source venv/bin/activate

3. Install app dependencies and local dev dependencies

pip install -r requirements/local.txt

4. Create a database and local .env config for va_explorer (edit .env if needed)

createdb va_explorer -U postgres && cp .env.template .env

5. Run va_explorer database migrations

./manage.py makemigrations && ./manage.py migrate

6. Initialize user permissions and create an admin to login with

./manage.py initialize_groups && ./manage.py seed_admin_user <EMAIL_ADDRESS> --password

Next, depending on the area of VA Explorer being contributed to, there are a variety of management commands available to import data, seed demo users, load locations, and more. See:

• Admin Commands
• Development Commands

Running & Testing

After setup, contributors should be able to run VA Explorer locally:

./manage.py runserver 0.0.0.0:8000

and access the interface by navigating to localhost:8000 in their browsers. Similarly, contributors should be able to lint (via pre-commit/ ruff) and test (via pytest) contributions like so:

pre-commit install && pre-commit run --all-files

pytest

Coverage reporting is also available via:

coverage run -m pytest && coverage report

configuration for these tools is provided by pyproject.toml

Contributors using the automatic cause of death assignment feature can do so by building the required docker services and running that management command:

docker-compose up --build && ./manage.py run_coding_algorithms

further documentation on development, including troubleshooting of common issues is available on the documentation website and good first issues are actively tagged by current contributors here

Thanks again, whether through usage, feature requests, bug reports, or pull requests, your involvement with VA Explorer is deeply appreciated!

Security & Privacy

VA Explorer uses open-source third-party libraries from well-known and/or reputable sources. The MITRE Corporation does not vet the security of those software libraries. If security concerns you, you or your organization may want to review the third-party libraries and their source code on GitHub.

Attribution

This project relies on contributions from the community, in addition to other existing VA open-source libraries, without which VA Explorer would not be possible. Portions of this code, therefore, are copyright the respective developers, which include, but may not be limited to, teams from the CDC Foundation (e.g., DHIS-2 export) and The Ohio State University (e.g., InterVA5, pyCrossVA, openVA pipeline).

Copyright & License

Copyright © 2020-2023, The MITRE Corporation. Licensed under Apache 2.0

The source of this information is the Data for Health Initiative, a joint project of the CDC Foundation and Bloomberg Philanthropies.

Available publicly via Apache License, Version 2.0. VA Explorer also includes external software that is available under a variety of licenses. See LICENSE for full license text(s).

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact

Contact [email protected] with any questions or comments.