5. Tutorials

Contents:

• 5.1. Git/GitHub
  • 5.1.1. Create an account & raise an issue on GitHub
    • 5.1.1.1. What is GitHub?
    • 5.1.1.2. Create an account
    • 5.1.1.3. Troubleshoot PyMoDAQ: raise an issue
  • 5.1.2. Basics of Git and GitHub
    • 5.1.2.1. Why Git?
    • 5.1.2.2. Installation & configuration for Windows
    • 5.1.2.3. Installation & configuration for Ubuntu
    • 5.1.2.4. Local use of Git
    • 5.1.2.5. Remote use of Git: GitHub
    • 5.1.2.6. Git in practice: integration within PyCharm
    • 5.1.2.7. Conclusion
  • 5.1.3. Authenticate to GitHub with an SSH key
    • 5.1.3.1. Prerequisite
    • 5.1.3.2. What is SSH?
    • 5.1.3.3. How to make a secure connection with SSH?
    • 5.1.3.4. Concluding remarks
• 5.2. How to modify existing PyMoDAQ’s code?
  • 5.2.1. Prerequisite
  • 5.2.2. The PyMoDAQ repositories
  • 5.2.3. PyMoDAQ branches
  • 5.2.4. How to propose a modification of the code of PyMoDAQ?
    • 5.2.4.1. (1) Fork the upstream repository
    • 5.2.4.2. (2) Clone our new remote repository locally
    • 5.2.4.3. (3) Do modifications and push
    • 5.2.4.4. (4) Pull request (PR) to the upstream repository
• 5.3. How to create a new plugin/package for PyMoDAQ?
  • 5.3.1. Prerequisite
  • 5.3.2. The PyMoDAQ’s plugin template repository
  • 5.3.3. Configuring a new plugin repository
  • 5.3.4. Publishing on Pypi
• 5.4. Story of an instrument plugin development
  • 5.4.1. The controller manual
  • 5.4.2. The installer
  • 5.4.3. The blue route: use the manufacturer GUI
  • 5.4.4. A shortcut through an existing green route? Readily available PyMoDAQ instrument plugins
  • 5.4.5. The gold route: control your device with a Python script
    • 5.4.5.1. What is a DLL?
    • 5.4.5.2. What is a Python wrapper?
    • 5.4.5.3. PIPython wrapper
    • 5.4.5.4. External open-source libraries
    • 5.4.5.5. Back to PIPython wrapper
    • 5.4.5.6. I’ve found nothing to control my device with Python! :(
  • 5.4.6. The green route: control your device with PyMoDAQ
    • 5.4.6.1. What is GitHub?
    • 5.4.6.2. Prepare your remote repository
    • 5.4.6.3. Prepare your local repository
    • 5.4.6.4. Install your package in edition mode
    • 5.4.6.5. Open the package with an adapted IDE
    • 5.4.6.6. Debug of the original plugin
    • 5.4.6.7. Write the class for our new instrument
    • 5.4.6.8. Commit our changes with Git
    • 5.4.6.9. Push our changes to our remote repository
    • 5.4.6.10. Pull request to the upstream repository
  • 5.4.7. Conclusion
• 5.5. How to contribute to PyMoDAQ’s documentation?
  • 5.5.1. The documentation of PyMoDAQ
    • 5.5.1.1. Documentation of the source code: docstrings
    • 5.5.1.2. Tests
    • 5.5.1.3. Website
  • 5.5.2. Sphinx
  • 5.5.3. Preparation
  • 5.5.4. Build the website locally
  • 5.5.5. Add a new tutorial
  • 5.5.6. reStructuredText (RST) language
    • 5.5.6.1. Page structure
    • 5.5.6.2. List
    • 5.5.6.3. External link (URL)
    • 5.5.6.4. Integrate an image
    • 5.5.6.5. Cross-referencing
    • 5.5.6.6. Glossary terms
  • 5.5.7. Submit our documentation to the upstream repository
• 5.6. Updating your instrument plugin for PyMoDAQ 4
  • 5.6.1. What’s new in PyMoDAQ 4
  • 5.6.2. What should be modified
    • 5.6.2.1. Imports
    • 5.6.2.2. Data emission
    • 5.6.2.3. Requirements
• 5.7. Tutorial On Data Manipulation and analysis
  • 5.7.1. Loading Data
  • 5.7.2. Plotting data
  • 5.7.3. Data Analysis
    • 5.7.3.1. Slicing the data
    • 5.7.3.2. Fitting the Data
  • 5.7.4. Summary