5. Tutorials

Contents:

• 5.1. Story of an instrument plugin development
  • 5.1.1. The controller manual
  • 5.1.2. The installer
  • 5.1.3. The blue route: use the manufacturer GUI
  • 5.1.4. A shortcut through an existing green route? Readily available PyMoDAQ instrument plugins
  • 5.1.5. The gold route: control your device with a Python script
    • 5.1.5.1. What is a DLL?
    • 5.1.5.2. What is a Python wrapper?
    • 5.1.5.3. PIPython wrapper
    • 5.1.5.4. External open-source libraries
    • 5.1.5.5. Back to PIPython wrapper
    • 5.1.5.6. I’ve found nothing to control my device with Python! :(
  • 5.1.6. The green route: control your device with PyMoDAQ
    • 5.1.6.1. What is GitHub?
    • 5.1.6.2. Prepare your remote repository
    • 5.1.6.3. Prepare your local repository
    • 5.1.6.4. Install your package in edition mode
    • 5.1.6.5. Open the package with an adapted IDE
    • 5.1.6.6. Debug of the original plugin
    • 5.1.6.7. Write the class for our new instrument
    • 5.1.6.8. Commit our changes with Git
    • 5.1.6.9. Push our changes to our remote repository
    • 5.1.6.10. Pull request to the upstream repository
  • 5.1.7. Conclusion
• 5.2. How to contribute to PyMoDAQ’s documentation?
  • 5.2.1. The documentation of PyMoDAQ
    • 5.2.1.1. Documentation of the source code: docstrings
    • 5.2.1.2. Tests
    • 5.2.1.3. Website
  • 5.2.2. Sphinx
  • 5.2.3. Preparation
  • 5.2.4. Build the website locally
  • 5.2.5. Add a new tutorial
  • 5.2.6. reStructuredText (RST) language
    • 5.2.6.1. Page structure
    • 5.2.6.2. List
    • 5.2.6.3. External link (URL)
    • 5.2.6.4. Integrate an image
    • 5.2.6.5. Cross-referencing
    • 5.2.6.6. Glossary terms
  • 5.2.7. Submit our documentation to the upstream repository
• 5.3. Updating your instrument plugin for PyMoDAQ 4
  • 5.3.1. What’s new in PyMoDAQ 4
  • 5.3.2. What should be modified
    • 5.3.2.1. Imports
    • 5.3.2.2. Data emission
    • 5.3.2.3. Requirements