From 460aef700db3db538cf084a743a6079d134cb0dd Mon Sep 17 00:00:00 2001 From: Thomas Athey Date: Wed, 30 Oct 2024 15:03:51 -0400 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a19e02d..757db21 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,37 @@ pip install -e . Note: Some parts of this package, including the `ThermoFisherVerios` class which helps implement this method on a Thermo Fisher scanning electron microscope depend on the proprietary package `autoscript_sdb_microscope_client`. +## Example Installation using venv on Windows + +1. Create virtual environment using venv with python 3.10 +``` + -m venv +``` +2. Activate environment +``` +\Scripts\activate +``` +3. Upgrade pip +``` +python -m pip install --upgrade pip +``` +4. Go to code directory +``` +cd +``` +5. Install code in editable mode +``` +python -m pip install -e . +``` +6. Check that smartem was installed (optional) +``` +pip list +``` +7. Run example script +``` +python examples\smart_em_script.py +``` +Note: we use `python -m` in order to call `pip` through our environment's interpreter. If you omit this, you might be running a different version of `pip` that exists outside your environment. # Status -- examples/smart_em_script.py: SmartEM script for running the SmartEM pipeline \ No newline at end of file +- examples/smart_em_script.py: SmartEM script for running the SmartEM pipeline