Skip to content
Extraits de code Groupes Projets
README.md 3,14 ko
Newer Older
  • Learn to ignore specific revisions
  • Nicolas Roisin's avatar
    Nicolas Roisin a validé
    # DOpeS
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Description
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    Data analysis and Operation Software (DOpeS) provides a set of tools for 
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    1. the analysis of data coming from lab equipment such as Raman spectrometer, white-light interferometer, ...
    2. the control of lab equipment such as multimeter, source measurement units, pressure generator, climatic chamber, monochromator, ...
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Structure
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    - **data_analysis** for the analysis of lab equipment:
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
        - Data processing function such as baseline removal, interpolation, filtering, ...
        - File handling to read data files and writting processed data in files
        - Specific functions to analyse measurements such as Raman specroscopy
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    - **equipment_control** for the control of various lab equipment:
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
        - Digital multimeter (DMM) *DMM7510*, *DMM6500* and *K2000*
        - Source Measurement Unit (SMU) *K2400* and *K2450* 
        - Semiconductor analyser *HP4145* and *K4200*
        - Monochromator *CM110*
        - Pressure generator and monitor *KAL100* 
        - Climatic chamber *SH242* (sh242.py)
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Requirements
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    DOpeS is made from functions, classes and scripts based on Python programming lanquage. The following packages are required for the data analysis and the equipment control:
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    - <a href=https://pypi.org/project/numpy/> **Numpy** </a> for the data handling and processing
    - <a href=https://pypi.org/project/scipy/> **SciPy** </a> for the data processing tools such as interpolation and filtering (only for *data_analysis* part)
    - <a href=https://pypi.org/project/PyVISA/> **Pyvisa** </a> for the communication with equipment (only for *equipment_control* part)
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    - <a href=https://pypi.org/project/pyserial/> **Pyserial** </a> for the serial communication with equipment (only for *equipment_control* part)
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Installation
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    DOpeS is easily installed by downloading the repository on you computer.
    If you want to keep track of the latest develepments, you can download the gitlab repository and keep it synchronized with the gitlab project:
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    To download it, you just have to type the following command in a terminal:
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    ```
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    git clone https://forge.uclouvain.be/LocLahaye/dopes.git
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    ```
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    To update it with the gitlab project, you can type:
    ```
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    cd path/to/dopes
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    git pull
    ```
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Usage
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    DOpeS is built as a set of python classes and functions.
    To use it, you only have to create a python script in you favorite IDE and insert the path to DOpeS folder at the beginning:
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ```
    import sys
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    sys.path.insert(1, '/path/to/dopes')
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ```
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    The various tools can then be accessed as any python package and class:
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ```
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    import equipment_control.equipment as eq
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    import equipment_control.k2400 as k2400
    import data_analysis.raman as ram
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ```
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    ## Support and contributing
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    We welcome any feedback on issue, missing operation or equipment but also idea for further improvements.
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    ## Authors and acknowledgment
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    The initial idea of this project has been thought by **Loïc Lahaye** and **Nicolas Roisin**.
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    
    ## License
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
     DOpeS © 2025 by Loïc Lahaye and Nicolas Roisin is licensed under <a href=https://creativecommons.org/licenses/by-nc-sa/4.0/> Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International </a> (<a href=https://creativecommons.org/licenses/by-nc-sa/4.0/> CC BY-NC-SA 4.0</a>) 
    
    Loïc Lahaye's avatar
    Loïc Lahaye a validé
    ## Project status
    
    Nicolas Roisin's avatar
    Nicolas Roisin a validé
    Still alive