diff --git a/README.md b/README.md index 8c1d1c7..2a54a1c 100644 --- a/README.md +++ b/README.md @@ -189,8 +189,7 @@ result = vl(my_video_arr, fps=my_video_fps) ### Example: Run example script with Docker If you encounter issues installing `vitallens-python` dependencies directly, you can use our Docker image, which contains all necessary tools and libraries. -This docker image is set up to execute the example Python script in `examples/test.py` for you. -Please note that the example script plots won't work when running them through Docker. +This docker image is set up to execute the example Python script in `examples/test.py` for you. #### Prerequisites @@ -231,6 +230,16 @@ docker run vitallens \ --method "VITALLENS" ``` +4. View the results + +The results will print to the console in text form. + +Please note that the example script plots won't work when running them through Docker. To to get the plot as an image file, run: + +``` +docker cp :/app/results.png . +``` + ## Linting and tests Before running tests, please make sure that you have an environment variable `VITALLENS_DEV_API_KEY` set to a valid API Key. diff --git a/examples/test.py b/examples/test.py index 58e307b..82839b3 100644 --- a/examples/test.py +++ b/examples/test.py @@ -83,6 +83,7 @@ def run(args=None): ax1.legend() if 'respiratory_waveform' in vital_signs: ax2.legend() plt.show() + plt.savefig('results.png') def method_type(name): try: