3. Tutorials

Contents:

• 3.1. Git/GitHub
  • 3.1.1. Create an account & raise an issue on GitHub
  • 3.1.2. Basics of Git and GitHub
  • 3.1.3. Authenticate to GitHub with an SSH key
• 3.2. How to modify existing PyMoDAQ’s code?
  • 3.2.1. Prerequisite
  • 3.2.2. The PyMoDAQ repositories
  • 3.2.3. PyMoDAQ branches
  • 3.2.4. How to propose a modification of the code of PyMoDAQ?
• 3.3. Your first plugin in 10 minutes
  • 3.3.1. Start from the template
  • 3.3.2. 1. Keep the instrument behind a small wrapper
  • 3.3.3. 2. The actuator
  • 3.3.4. 3. The detector
  • 3.3.5. 4. Test it without hardware
  • 3.3.6. 5. Check and run
• 3.4. Write and release a new plugin
  • 3.4.1. Prerequisites
  • 3.4.2. The PyMoDAQ’s plugin template repository
  • 3.4.3. Configuring a new plugin repository
  • 3.4.4. Where should a plugin live?
  • 3.4.5. Releasing on PyPI
  • 3.4.6. Resources
• 3.5. Story of an instrument plugin development
  • 3.5.1. The controller manual
  • 3.5.2. The installer
  • 3.5.3. The blue route: use the manufacturer GUI
  • 3.5.4. A shortcut through an existing green route? Readily available PyMoDAQ instrument plugins
  • 3.5.5. The gold route: control your device with a Python script
  • 3.5.6. The green route: control your device with PyMoDAQ
  • 3.5.7. Conclusion
• 3.6. How to contribute to PyMoDAQ’s documentation?
  • 3.6.1. The documentation of PyMoDAQ
  • 3.6.2. Sphinx
  • 3.6.3. Preparation
  • 3.6.4. Build the website locally
  • 3.6.5. Add a new tutorial
  • 3.6.6. reStructuredText (RST) language
  • 3.6.7. Submit our documentation to the upstream repository
• 3.7. Tutorial On Data Manipulation and analysis
  • 3.7.1. Loading Data
  • 3.7.2. Plotting data
  • 3.7.3. Data Analysis
  • 3.7.4. Summary
• 3.8. Jupyter Lab
• 3.9. Communication With Devices Outside of PyMoDAQ
  • 3.9.1. Python Devices Drivers Without PyMoDAQ Plugin
  • 3.9.2. Drivers in Another Language