@@ -8,29 +8,31 @@ Data analysis and Operation Software (DOpeS) provides a set of tools for
## Structure
-**data_analysis**
-**equipment_control**
-**equipment_control** for the control of various lab equipment:
- 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)
- script examples for the equipments
## Requirements
ChOpeS 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:
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:
-**Numpy** for the data handling and processing
-**SciPy** for the data processing tools such as interpolation and filtering (only for *data_analysis* part)
-**Pyvisa** for the communication with equipment (only for *equipment_control* part)
The python packages can be installed from python the Python Package Index (pip)
'''
The python packages can be installed from python the Python Package Index (pip):
```
pip install numpy, scipy, pyvisa
'''
```
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
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:
```
cd existing_repo
...
...
@@ -40,22 +42,24 @@ git push -uf origin main
```
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
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:
The various tools can then be accessed as any python packages and classes:
```
import equipment_control.equipment as eq
import equipment_control.EQUIPMENT_TYPE as EQ_TYPE
import equipment_control.k2400 as k2400
import data_analysis.raman as ram
```
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
We welcome any feedback on issued, missing operation or equipment but also idea for further improvements.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
...
...
@@ -65,10 +69,9 @@ For people who want to make changes to your project, it's helpful to have some d
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
The intitial idea of this project has been thought by **Loïc Lahaye** with the help of **Nicolas Roisin**.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
