- Install VSCode.
- In File Explorer, double-click the
OPEN.code-workspacefile to open it. - Install the recommended extensions. (Wait for the popup in the lower-right corner prompting you to install them.)
- Install Python 3.9 or later. (Not covered here; I'm using 3.13.3)
- Open
program.ipynbfrom the Explorer in VSCode. - Click Select Kernel → Python Environments... → Create Python Environment → Venv.
- You may see a list of Python versions — choose the one you installed.
- See Next.
- Put your data folder in
data. Make it if not exists. For example:
data
├── 25.04.15
│ ├── pfoa
│ │ ├── 1
│ │ │ ├── 032410023904.dat
│ │ │ └── 032410023915.dat
│ │ ├── 2
│ │ │ ├── 032410024828.dat
│ │ │ └── 032410024857.dat
│ │ ├── 3
│ │ │ ├── 032410031711.dat
│ │ │ └── 032410031758.dat
│ │ └── 4
│ │ ├── 032410032628.dat
│ │ └── 032410032655.dat
- Open
program.ipynband set the appropriate data folder path in the second cell by passing it toManager(). For example, if you want to analyze folder 2 inside pfoa, setManager()as follows:
# Use '/' to express folder
manager = Manager(r"25.04.15/pfoa/2")-
Cells can be run with
Shift + Enter. Run the cells inprogram.ipynbfrom top to bottom — execution order matters. Or, you can simply click Restart → Run All. -
When the third cell is executed, a graph appears in the browser. You can scroll through the graph using the mouse wheel, and once you've gone through the entire graph, the interaction ends and the analysis data is saved in the
analysisfolder.
The linear traversal is performed from the far right of the attach signal graph. The program first traverses the horizontal (flat) section, then the linear section. The graph assumes that, when read from right to left, the horizontal section ends and the linear section begins immediately afterward.
window_size(default 5): Determines how much data to average in the moving average. A larger window will smooth the graph more, which can cause horizontal/linear region detection to fail.gradient_threshold(default 0.003): If the slope exceeds this value, the flat region is considered to be over.curvature_threshold(default 0.1): If the curvature does not exceed this value, it is considered a linear region. If it exceeds the value, the linear region is considered to be over.minimum_search_range(default 30): Since the curvature-based minimum location is not exact(but close), the exact minimum is searched for within this range.
The outcome of the program’s analysis depends on the quality and characteristics of the input data. If the probe speed is measured too fast or too slow, the linear region may not be properly detected. This is normal and that's why you can control parameters. You can adjust the curvature_threshold to determine the start of the linear increase region, and the gradient_threshold to determine its end. The quality of the data is directly proportional to the ease of analysis. With high-quality data, the program can perform well without the need to tweak parameters—this will likely benefit your research as well!
Artificially adjusting parameters to force analysis on low-quality data is not recommended. This program is designed to reduce analysis time, not experimental time. Please keep that in mind.
Error Message
Running cells with '.venv (Python 3.13.3)' requires the ipykernel package.
Install 'ipykernel' into the Python environment.
Install ipykernel
Error Message
ModuleNotFoundError: No module named 'numpy'
This is because your computer does not have a specific package — in this case, numpy. Find the first cell that contains:
# !pip install numpy!pip install SPECIFIC_PACKAGE_NAME installs a specific package on your computer. Remove the # and run the cell with Shift + Enter. You may want to add the # back after installing packages.
Open the GitHub Issues.
GitHub Repository → Issues → New issue