Metadata-Version: 2.1
Name: SSUphysicsTools
Version: 2.0.1
Summary: 숭실대학교 물리학과 실험에 사용되는 데이터 처리 및 시각화 도구
Home-page: https://github.com/kty1004/SSUphysicsExperiment_Supporting_tools?tab=readme-ov-file#readme
Author: Taeyoung Kim
Author-email: rocketman@soongsil.ac.kr
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.13.0
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: pandas

# SSUphysics experiment supporting tools
숭실대학교 물리학과 물리계측실험 수업에서 유용하게 사용할 수 있는 python 페키지입니다.

> 향후 다른 실험 수업에서도 사용할 수 있도록 확장할 예정입니다.

## How to install
```zsh
pip install SSUphysicsTools
```

## Example
먼저 terminal에서 다음과 같이 실행하세요.
```zsh
git clone --no-checkout https://github.com/kty1004/SSUphysicsExperiment_Supporting_tools.git
cd SSUphysicsExperiment_Supporting_tools
git sparse-checkout init --cone
git sparse-checkout set examples
rm README.md setup.py
cd examples
```
이후 `code .`을 사용하여 vscode를 실행하거나, `jupyter notebook`을 사용하여 jupyter notebook을 실행하세요.
### required packages to run examples
예제를 실행하기 위해서는 다음과 같은 패키지들이 설치되어 있어야 합니다.
- numpy
- pandas
- matplotlib
- scipy
- SSUphysicsTools
- jupyter notebook (optional)
- scikit-learn
이를 위해 다음의 명령어를 실행하세요.
```zsh
pip install numpy pandas matplotlib scipy SSUphysicsTools jupyter scikit-learn
```

## How to use
### Setting up
실험 데이터는 data 폴더에 저장되어 있어야 합니다. 이 때 data 폴더는 다음과 같은 구조를 가지고 있어야 합니다.
```
data
├── experiment 1
│   ├── 1.csv
│   ├── 2.csv
├── experiment 2
│   ├── 1.csv
│   ├── 2.csv
└── ...
```
만약 data 폴더가 준비되지 않았더면, 자동으로 data 폴더를 생성하고 `DataDirectoryEmptyError`를 발생시켜 data 폴더에 실험 데이터를 넣도록 알려줍니다.

### getting data
get_all_csv_paths method를 이용하여 실험 데이터를 가져올 수 있습니다.

### processing data
- Regression
    - cosine_regression
- Delate_offset
### analyzing data
- Phase_shift
    - find_min_x_vector
    - find_ym_y0
- get_error_rate
### plot
- Plots
    - rough data plot
    - bode plot
- plot_table
