diff --git a/README.md b/README.md index d016df84..f7d01db7 100644 --- a/README.md +++ b/README.md @@ -108,13 +108,21 @@ sudo -u openflexure-ws openflexure-microscope-server --fallback -c microscope_co To start the simulation server: +* Ensure all steps of the installation for your platform of choice are complete. * Activate the virtual environment that was set up during installation * Run the following command: - openflexure-microscope-server --fallback -c ./ofm_config_simulation.json +`openflexure-microscope-server --fallback -c ./ofm_config_simulation.json` + +* Open the address displayed in the terminal in any browser. +* To close the simulation server, return to the terminal and press `ctrl + c`. > Note: If you are using Windows, we advise running this command in PowerShell. If it doesn't work this, might be a permission issue on managed machines, in which case try executing the command in a CMD terminal. +> Note: If you receive an error saying that port 5000 is already in use, you can specify a different port to run the simulation on using `--port`: +> +> `openflexure-microscope-server --fallback --port 8081 -c ./ofm_config_simulation.json` + A [full video walkthrough of running the simulation server](https://youtu.be/Z8verCqfj9s) is available on our YouTube Channel. You can find more information on using the simulation server in the [Simulation Guide](./simulation_guide.md). diff --git a/simulation_guide.md b/simulation_guide.md index 3b091b5c..9558e793 100644 --- a/simulation_guide.md +++ b/simulation_guide.md @@ -2,6 +2,16 @@ This guide walks you through running the simulation server for the OpenFlexure Microscope, along with useful tips for using the simulation features. +The simulation server GUI is a copy of the GUI you would find on the hardware with a simulated sample you can explore. Most functionality included in the hardware operates on the simulation server. This includes: + +* Camera stage mapping and 'click to move' +* Scanning and stitching* +* Autofocus +* Image capture +* Stage navigation + +**Please note: the final stitch at the end of a scan currently doesn't work on Windows.* + --- ## Starting the Simulation Server @@ -25,6 +35,20 @@ For a step-by-step demonstration, watch the [full video walkthrough on running t --- +## Running a simulated scan + +To run a simulated scan, you first need to set a background image: + +1. Click on the settings tab on the left +2. Navigate to the **Camera** settings under **Microscope Settings** +3. Click `Remove Sample`. This removes the simulated sample from the camera stream +4. Click on the **Background Detect** tab on the left and click `Set Background` +5. Repeat the steps 1 and 2 to return to the camera settings and click `Add Sample` + +You are now ready to start a simulated scan in the Slide Scan tab. + +--- + ## Simulation Settings and Tips --- @@ -70,3 +94,4 @@ For a step-by-step demonstration, watch the [full video walkthrough on running t --- If you need further help, reach out to the community on the [OpenFlexure Forum](https://openflexure.discourse.group/). +