﻿*********************************************** README.txt **************************************************

Title:                      Design optimization of low frequency vibration energy harvester  based on 
							magnetic levitation: Datasets and scripts
Version:                    2.0
Date of Release:            2023/09/04
Identifier:                 doi:10.5281/zenodo.8317223
Permalink:                  http://dx.doi.org/10.5281/zenodo.8317223

*************************************************************************************************************

Associated publication:     I. Royo-Silvestre, J. J. Beato-López, C. Gómez-Polo "Design optimization of 
							low frequency vibration energy harvester  based on magnetic levitation" 
							(paper yet to be published)
                              
Link to publication:	    (paper yet to be published)

Suggested citation:         Please reference the associated publication above when using any datasets or
                              materials described in this README file.

Contact information:        Isaac Royo Silvestre, 
							Universidad Pública de Navarra, 
							Pamplona, Spain, 
							isaac.royo@unavarra.es

Dates of data collection:   2023/03

Geographic location:        Pamplona, Spain

Funding sources:            This work is funded by Spanish Agencia Estatal de Investigación and Ministerio 
							de Ciencia e Innovación MCIN/AEI/ 10.13039/501100011033 and by "European Union 
							NextGenerationEU/PRTR, project TED2021-130884B-I00.
							Open access funding provided by Universidad Pública de Navarra.

License:                    CC BY 4.0CC BY 4.0

------------------------------------------------------------------------------------------------------------

This directory contains the following datasets and supplementary materials:

    ------------------------------
    SCRIPTS
    ------------------------------

    - harvester_op.m: 		Matlab script to automate the design and optimize a magnetic spring based 
							vibration energy harvester (more information in the associated paper)      
    - harvester_op_par.m: 	Matlab script, a version of harvester_op.m modified for parallel computing
							and shorter execution time in multicore computers.  
				(file added in v 2.0 of the data upload)

    --------------------------------
    DATASETS
    --------------------------------

    - data.zip: 			Experimental data recorded by the datalogger as well as tabular data required 
							to plot curves (compressed zip file) in csv format


Specific documentation of each file is described in readme files.

Refer to the original manuscript (see above) and the text of the Supplementary Materials published alongside this manuscript for additional information regarding the collection and generation of these data.

------------------------------------------------------------------------------------------------------------

  ---------------------------------------------------------------------
  DOCUMENTATION FOR 'harvester_op.m'
  ---------------------------------------------------------------------

    This is a Matlab script, it is a text file and can be read using any text editor. However it has to 
	be executed via Matlab, the script contains enough documentation as comments.

  ---------------------------------------------------------------------
  DOCUMENTATION FOR 'harvester_op_par.m'
  ---------------------------------------------------------------------

    This is a Matlab script, it is a text file and can be read using any text editor. However it has to 
	be executed via Matlab, the script contains enough documentation as comments.
	Note that, due to Matlab approach to parallel computing, the script will make use of
	multiples cores in local machines, but may fail to use multiple cores when run
	in remote clusters (depending on the configuration of the cluster a matlab client)

  ---------------------------------------------------------------
  DOCUMENTATION FOR 'data.zip'
  ---------------------------------------------------------------

    The zip file contains another readme.txt file (that explains the content of the zip file in detail), 
	multiple .dat files obtained by a datalogger during the experimental vibration tests on the 
	harvester prototype (see format in the readme.txt contained in the zip), and a folder "curves".
	The curves folder contains tabular data in .csv files that represents our analysis of the .dat
	files, these files can be used to plot curves.
