Sovereign 8s.is mirror of standardgalactic/AEsensor_Calibration_ARX
  • Jupyter Notebook 97.8%
  • Python 1.9%
  • MATLAB 0.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
kura-okubo ad53148ff8
Some checks failed
Run tests / test (macOS-latest) (push) Has been cancelled
Run tests / test (ubuntu-latest) (push) Has been cancelled
Update test_remove_resp_digitalfilt.py
2026-04-30 13:40:20 +02:00
.github/workflows update 2025-03-17 21:27:26 +09:00
data update with new event waveform 2025-03-17 21:00:41 +09:00
figure remove grid 2025-04-26 23:52:04 +09:00
src remove grid 2025-04-26 23:52:04 +09:00
test Update test_remove_resp_digitalfilt.py 2026-04-30 13:40:20 +02:00
.gitignore update with new event waveform 2025-03-17 21:00:41 +09:00
environment.yml update with new event waveform 2025-03-17 21:00:41 +09:00
LICENSE update with new event waveform 2025-03-17 21:00:41 +09:00
matlabkernel_existinglicense.png update with new event waveform 2025-03-17 21:00:41 +09:00
README.md Update reference citation format in README 2026-04-30 13:27:08 +02:00

AEsensor Calibration using ARX model

This repository contains the MATLAB function to conduct the sensor calibration using the autoregressive exogenous model (ARX) model, represented by poles and zeros, and an example to apply the response removal with the ARX model to the AE waveform. Jupyter notebooks are available to perform those processings above.

Run tests codecov DOI

List of Notebooks

fig1

Installation to run the notebooks

The easiest way to set up the environment for the notebooks is installing the dependencies using Miniconda (Conda also works, but miniconda is enough to execute the notebooks in this repo).

  1. install the miniconda following the instruction in the website.

  2. Clone the git repository and create the environment Type the commands below in the terminal.

git clone https://github.com/kura-okubo/AEsensor_Calibration_ARX.git
cd AEsensor_Calibration_ARX
conda env create -n AEsensor_arx -f environment.yml
conda activate AEsensor_arx
python3 -m pip install jupyter-matlab-proxy

These commands download the repository in your local machine, create the environment with the dependencies used in the notebooks, and install the matlab kernel for the jupyter notebook.

If struggling with creating conda enviromment, like stacking at Solving environment, using mamba is recommended.

conda install mamba -c conda-forge
reset
mamba env create -n AEsensor_arx -f environment.yml
  1. Find the path to the MATLAB executable file by
which matlab

If the path to the executable e.g.

/Applications/MATLAB_R2024b.app/bin/matlab

is returned, you are ready to execute the notebook. If not, export the path to the directory with matlab like

export PATH="$PATH:/Applications/MATLAB_R2024b.app/bin/"

If you have an error like

$/Applications/MATLAB_R2024b.app/bin/matlab
env: /Applications/MATLAB_R2024b.app/bin/maci64/path_per_install: No such file or directory
mkdir: /bin/maci64: Operation not permitted

    matlab: No MATLAB bin directory for this machine architecture.

           ARCH = maci64

Check if the terminal app is open with Rosetta option. Turn it off if you download native Apple silicon MATLAB.

  1. Launch the Jupyter lab Type in the terminal as following:
cd src
jupyter lab
  1. Open the notebooks selecting from the side bar of the jupyter lab.

Tips: Choose the Exisiting License when you already activate the desktop MATLAB app.

matlabkernel_existinglicense

The default browser to open the jupyter lab can be changed following here.

Uninstall the environment

To remove (uninstall) the environment, run the followings:

conda deactivate
conda env remove -n AEsensor_arx

Matlab license

To use the src/lsq_arx.m and to execute the notebook of 01_AEsensor_calibration_arx.ipynb, you need a license for the followings:

We use butterworth filter and tf2zpk implemented in the Signal Processing Toolbox.

fig1 Figure 1. Bode plot of the AE sensor. fig1 Figure 2. Comparison before and after the response removal of the AE waveform.

Reference

Okubo, K., Yamashita, F. & Fukuyama, E. Dynamics of non-self-similar earthquakes illuminated by a controlled fault asperity. Nat Commun 17, 3860 (2026). https://doi.org/10.1038/s41467-026-72217-x