ShowWhy is an interactive application that guides users through the process of answering a causal question using observational data.
In use, it has the potential to empower domain experts (who may not be data scientists) to develop a higher standard of evidence than could be achieved using conventional forms of exploratory data analysis (since correlation does not imply causation).
In other words, ShowWhy enables emulation of randomized controlled trials that produce a high standard of real-world evidence.
-
Windows Subsystem for Linux (WSL): https://docs.microsoft.com/en-us/windows/wsl/setup/environment (Only for Windows users)
-
Docker (For all platforms):
-
Docker Compose (For Linux Users):
- Docker Compose: https://docs.docker.com/compose/install/ (look at the correct tab depending on your Operating System)
Open a Poweshell terminal, navigate to the directory where this project is located and run one of the commands at the Commands section of this README.
Open a terminal, navigate to the directory where this project is located and run.
NOTE: For linux you will need to replace the - in docker-compose for a space in order for the commands to work, for example: docker-compose up --build -d in linux should be docker compose up --build -d
docker-compose up --build -d: Start all the containers (UI and Backend with all the dependencies) - Useful for users to start using ShowWhydocker-compose up --build -d webapp: Start only the UI containerdocker-compose up --build -d reverseproxy: Start all the containers needed for the backend and proxy for UI (the UI is excluded) - Useful for UI developmentdocker-compose up --build -d functions: Start all the containers needed for the backend except the proxy - Useful for backend development
To stop using showwhy you can run these commands on the same powershell terminal:
docker-compose stop: Stops the containers without removing anythingdocker-compose down -v: Stops and removes all the containers and volumes used - Use when you stop using ShowWhydocker-compose rm --force: Use afterdocker-compose down -vto delete all the data used in previous ShowWhy runs
To be able to work on the javascript package you will need to install:
To install all dependencies you must run yarn install in the root folder of this project.
This process will setup all dependencies needed to run javascript packages locally.
yarn start:webapp
We deploy our services to an Azure environment, as you can see in the deployment instructions
Code licensed under the MIT License.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.