================ Quickstart Guide ================ To get started using WEI, we recommend the following resources: #. The `WEI Template Workcell `_ provides a complete, working minimal example of a WEI workcell. It is designed to be easy to understand and modify. If you are new to WEI, we recommend starting here to understand how WEI works. This template workcell can also be used as a starting point for your own workcell. #. To learn more about the core concepts underlying WEI, consult the `Core Concepts `_ section. #. To learn more about how to write and develop your own experiment applications, workflows, workcells, or modules, consult the `How To Guides `_ I want to Learn... =================== How to use an existing WEI-powered Workcell ============================================ To learn how to use an existing WEI-powered workcell, we recommend looking into: - :doc:`concepts/experiment` and :doc:`how-to/experiment` to understand the basics of how to write and run an experiment application. - :doc:`concepts/workflow` and :doc:`how-to/workflow` to understand how to write and use workflows in your experiments. - :doc:`concepts/workcell` and :doc:`concepts/module` - The `WEI Template Workcell`_, for trying out these concepts using WEI on your own computer. - Any documentation specific to your target workcell, if available. .. _how-to-develop-workcell: How to develop a new WEI-powered Workcell ========================================= To learn how to develop a new WEI-powered workcell, we recommend looking into: - :doc:`concepts/workcell` and :doc:`how-to/workcell` to understand the basics of how to develop a workcell. - :doc:`concepts/module` and :doc:`how-to/module` to understand how modules, the building blocks of a workcell, work. - :doc:`concepts/workflow` and :doc:`concepts/experiment` - :doc:`deployment_guide/index` - The `WEI Template Workcell`_, for trying out these concepts using WEI on your own computer, and to use as a template to create your own workcell. How to integrate a new Device/Instrument/Robot with WEI ======================================================= To learn how to develop a new WEI-compatible module to control a device, we recommend looking into: - :doc:`concepts/module` and :doc:`how-to/module` to understand how modules, the building blocks of a workcell, work, and how to write them. - :doc:`deployment_guide/index` - :doc:`concepts/workflow` and :doc:`concepts/experiment` - :doc:`concepts/workflow` and :doc:`concepts/experiment` - :doc:`concepts/workflow` and :doc:`concepts/experiment` - The `WEI Template Workcell`_, for trying out these concepts using WEI on your own computer, and to use as a template to test your new module in a workcell setup.