tdehaeze/nass-matlab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Thomas Dehaeze 2025-04-21 10:27:10 +02:00
parent e5b9f2264d
commit 64f564f7a1
1 changed files with 46 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
README.md
View File

@ -4,7 +4,7 @@
**University:** Liège Université **University:** Liège Université
**Date:** April 2025 **Date:** April 2025
<!-- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.XXXXXXX.svg)](https://doi.org/10.5281/zenodo.XXXXXXX) --> [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15254389.svg)](https://doi.org/10.5281/zenodo.15254389)
## Abstract ## Abstract
@ -50,19 +50,19 @@ The repository is organized as follows:
``` ```
. .
├── A1-nass-uniaxial-model \# Every Section in the PhD thesis has its own direction ├── A1-nass-uniaxial-model # Every Section in the PhD thesis has its own direction
├── A2-nass-rotating-3dof-model ├── A2-nass-rotating-3dof-model
├── A3-micro-station-modal-analysis ├── A3-micro-station-modal-analysis
├── A4-simscape-micro-station \# The directory for each section is structure as follows: ├── A4-simscape-micro-station # The directory for each section is structure as follows:
│ ├── mat \# - All raw data │ ├── mat # - All raw data
│ ├── src \# - All Matlab functions, automatically added to the path │ ├── src # - All Matlab functions, automatically added to the path
│ ├── STEPS \# - .step files used for the multi-body (Simscape) model │ ├── STEPS # - .step files used for the multi-body (Simscape) model
│ ├── subsystems \# - subsystems used in the multi-body (Simscape) model │ ├── subsystems # - subsystems used in the multi-body (Simscape) model
│ ├── ustation_1_kinematics.m \# - The Matlab scripts corresponding to the different sections │ ├── ustation_1_kinematics.m # - The Matlab scripts corresponding to the different sections
│ ├── ustation_2_modeling.m │ ├── ustation_2_modeling.m
│ ├── ustation_3_disturbances.m │ ├── ustation_3_disturbances.m
│ ├── ustation_4_experiments.m │ ├── ustation_4_experiments.m
│ └── ustation_simscape.slx \# - The Simscape model used in this particular section │ └── ustation_simscape.slx # - The Simscape model used in this particular section
├── A5-simscape-nano-hexapod ├── A5-simscape-nano-hexapod
├── A6-simscape-nass ├── A6-simscape-nass
├── B1-nass-geometry ├── B1-nass-geometry
@ -74,12 +74,13 @@ The repository is organized as follows:
├── C3-test-bench-struts ├── C3-test-bench-struts
├── C4-test-bench-nano-hexapod ├── C4-test-bench-nano-hexapod
├── C5-test-bench-id31 ├── C5-test-bench-id31
├── init.m \# Optional: Some Matlab configuration to have same figure display ├── init.m # Optional: Some Matlab configuration to have same figure display
├── LICENSE \# MIT License is used for all the code in this repository ├── LICENSE # MIT License is used for all the code in this repository
└── README.md \# The present file └── README.md # The present file
```` ````
## Requirements ## Requirements
To run the code and reproduce the results in this repository, you will need the following software environment: To run the code and reproduce the results in this repository, you will need the following software environment:
@ -93,80 +94,65 @@ To run the code and reproduce the results in this repository, you will need the
**Software:** **Software:**
* **MATLAB Version:** 9.12 (R2022a) Update 8 or later compatible version. * **MATLAB Version:** 9.12 (R2022a) Update 8 or later compatible version.
* **Required MATLAB Toolboxes:** * **Required MATLAB Toolboxes:**
* Simulink: Version 10.5 (R2022a) * Simulink: Version 10.5
* Control System Toolbox: Version 10.11.1 (R2022a) * Control System Toolbox: Version 10.11.1
* Curve Fitting Toolbox: Version 3.7 (R2022a) * Curve Fitting Toolbox: Version 3.7
* Optimization Toolbox: Version 9.3 (R2022a) * Optimization Toolbox: Version 9.3
* Robust Control Toolbox: Version 6.11.1 (R2022a) * Robust Control Toolbox: Version 6.11.1
* Signal Processing Toolbox: Version 9.0 (R2022a) * Signal Processing Toolbox: Version 9.0
* Simscape: Version 5.3 (R2022a) * Simscape: Version 5.3
* Simscape Multibody: Version 7.5 (R2022a) * Simscape Multibody: Version 7.5
* Simulink Control Design: Version 6.1 (R2022a) * Simulink Control Design: Version 6.1
* Symbolic Math Toolbox: Version 9.1 (R2022a) * Symbolic Math Toolbox: Version 9.1
* System Identification Toolbox: Version 9.16 (R2022a) * System Identification Toolbox: Version 9.16
## Instructions for Reproduction ## Instructions for Reproduction
1. **Clone the repository:** 1. **Clone the repository:**
```bash * `git clone https://git.tdehaeze.xyz/tdehaeze/nass-matlab`
git clone [https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories) * Or download the repository from [Zenodo](https://doi.org/10.5281/zenodo.15254389)
cd [repository folder name]
```
2. **Set up MATLAB Environment:** 2. **Set up MATLAB Environment:**
* Ensure MATLAB R2022a and all required toolboxes listed above are installed. * Ensure MATLAB R2022a and all required toolboxes listed above are installed.
* Open MATLAB. * Open MATLAB.
* Navigate to the root directory of the cloned repository within MATLAB. * Navigate to the root directory of the cloned repository within MATLAB.
* Add the repository's folders to the MATLAB path. You can often do this by running the following command in the MATLAB console: * (optional) If same figure appearance is wanted, copy the `init.m` file into your own `init.m` file.
```matlab * Enter the directory corresponding to a PhD thesis section, for instance `A4-simscape-micro-station`.
addpath(genpath(pwd));
```
*(Note: Check if you need a more specific path setup script)*
3. **Run the Code:** 3. **Run the Code:**
* [Provide specific instructions here. For example:] * The code corresponding to a sub-section can be run with `run ustation_1_kinematics.m` or by pressing `F-5` once the Matlab file is openned.
* "To reproduce all figures and results, run the main script: `main_script.m`" * All the figures corresponding to this sub-section should be computed and displayed.
* "Alternatively, run scripts in the following order:" * Depending on the particular sub-section, the computation may take some time, especially when multi-body simulation is involved.
* `scripts/processing/preprocess_data.m`
* `scripts/simulations/run_model_simulation.m`
* `scripts/analysis/analyze_results.m`
* `scripts/plotting/generate_all_figures.m`
* Specify where the outputs (figures, tables, data files) will be saved (e.g., in the `results/` directory).
* Mention expected run times if some scripts are computationally intensive.
## Citation ## Citation
If you use the code, data, or findings from this repository or the associated thesis, please cite: If you use the code, data, or findings from this repository or the associated thesis, please cite:
**Thesis:** **Thesis:**
* [Your Name] ([Year]). *[Your Thesis Title Here]*. PhD Thesis, [Your University Name]. [Link to university library record or official source if available] * Dehaeze, T. (2025). Nano active stabilization of samples for tomography experiments: a mechatronic design approach. Université de Liège.
**Software/Data Repository (Zenodo):** **Software/Data Repository (Zenodo):**
* [Your Name] ([Year]). *[Repository Title, e.g., Code and Data for PhD Thesis: Your Thesis Title Here]*. Zenodo. [https://doi.org/10.5281/zenodo.XXXXXXX](https://doi.org/10.5281/zenodo.XXXXXXX) *(<- Replace with your DOI)* * Dehaeze, T. (2025). Code and Data for PhD Thesis: Nano active stabilization of samples for tomography experiments: a mechatronic design approach. Zenodo. https://doi.org/10.5281/zenodo.15254389
```bibtex ```bibtex
@phdthesis{YourLastNameYEARphd, @phdthesis{dehaeze25_nano_activ_stabil,
author = {[Your Name]}, author = {Dehaeze, T.},
title = {[Your Thesis Title Here]}, school = {Universit{\'e} de Li{\`e}ge},
school = {[Your University Name]}, title = {Nano Active Stabilization of samples for tomography experiments: A mechatronic design approach},
year = {[Year]}, year = 2025,
address = {[City, Country]},
url = {[Link to thesis, optional]}
} }
@software{[YourLastNameYEARzenodo], @misc{dehaeze25_nano_activ_stabil_zenodo,
author = {[Your Name]}, author = {Dehaeze, T.},
title = {[Repository Title, e.g., Code and Data for PhD Thesis: Your Thesis Title Here]}, title = {Nano Active Stabilization of samples for tomography experiments: A mechatronic design approach},
month = {[Month of Zenodo publication]}, month = {5},
year = {[Year of Zenodo publication]}, year = {2025},
publisher = {Zenodo}, publisher = {Zenodo},
version = {[Version/tag used for Zenodo archive, e.g., v1.0.0]}, doi = {10.5281/zenodo.15254389},
doi = {10.5281/zenodo.XXXXXXX}, url = {https://doi.org/10.5281/zenodo.15254389}
url = {[https://doi.org/10.5281/zenodo.XXXXXXX](https://doi.org/10.5281/zenodo.XXXXXXX)}
} }
```` ````
*(Note: Fill in the BibTeX details and update the DOI)*
## License ## License
The code and associated files in this repository are licensed under the MIT License. See the [LICENSE](LICENSE) file for details. The code and associated files in this repository are licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
@ -190,7 +176,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
## Contact
For questions about the code, data, or thesis, please contact [Your Name] at [Your Email Address].