{"id":19015271,"url":"https://github.com/americocunhajr/electrom","last_synced_at":"2025-10-13T22:42:25.526Z","repository":{"id":80384764,"uuid":"280539136","full_name":"americocunhajr/ElectroM","owner":"americocunhajr","description":"ElectroM is a Matlab code to simulate the nonlinear dynamics of an electromechanical system.","archived":false,"fork":false,"pushed_at":"2025-04-04T19:38:43.000Z","size":53258,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-17T18:23:00.402Z","etag":null,"topics":["computational-mechanics","computational-physics","dynamical-systems","electromechanical-system","multiphysics","nonlinear-dynamics"],"latest_commit_sha":null,"homepage":"https://americocunhajr.github.io/ElectroM","language":"MATLAB","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/americocunhajr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-17T22:48:25.000Z","updated_at":"2025-04-04T19:38:47.000Z","dependencies_parsed_at":"2024-11-08T19:50:00.810Z","dependency_job_id":null,"html_url":"https://github.com/americocunhajr/ElectroM","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americocunhajr%2FElectroM","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americocunhajr%2FElectroM/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americocunhajr%2FElectroM/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/americocunhajr%2FElectroM/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/americocunhajr","download_url":"https://codeload.github.com/americocunhajr/ElectroM/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250354290,"owners_count":21416748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["computational-mechanics","computational-physics","dynamical-systems","electromechanical-system","multiphysics","nonlinear-dynamics"],"created_at":"2024-11-08T19:36:34.455Z","updated_at":"2025-10-13T22:42:20.506Z","avatar_url":"https://github.com/americocunhajr.png","language":"MATLAB","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Electromechanical Dynamic Code\n\n**ElectroM: Electromechanical Dynamic Code** is a Matlab code designed to simulate the nonlinear dynamics of typical electromechanical systems. This package includes two physical-mathematical models:\n- **Full-order model:** Considers the mutual interaction between electrical and mechanical sub-systems, resulting in a coupled system of ODEs.\n- **Reduced-order model:** Considers only the influence of the mechanical sub-systems on the electrical one, resulting in a decoupled system of ODEs.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"logo/CartMotorCircuit.png\" width=\"60%\"\u003e\n\u003c/p\u003e\n\n### Table of Contents\n- [Overview](#overview)\n- [Features](#features)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Reproducibility](#reproducibility)\n- [Authors](#authors)\n- [Citing ElectroM](#citing-electrom)\n- [License](#license)\n- [Institutional support](#institutional-support)\n- [Funding](#funding)\n\n### Overview\n**ElectroM** was used to generate the results reported in the following works:\n- **A. Cunha Jr, M. Pereira, R. Avanço, A. M. Tusset, and J. M. Balthazar**, *ElectroM: ElectroMechanical dynamic code*, Software Impacts, 17:100533, 2023. \u003ca href=\"https://doi.org/10.1016/j.simpa.2023.100533\" target=\"_blank\"\u003eDOI\u003c/a\u003e\n- **A. Cunha Jr, M. Pereira, R. Avanço, A. M. Tusset, and J. M. Balthazar**, *On the modeling of nonlinear electromechanical systems*, Meccanica, 57:2679-2697, 2022. \u003ca href=\"https://doi.org/10.1007/s11012-022-01542-4\" target=\"_blank\"\u003eDOI\u003c/a\u003e\n- **R. H. Avanço, D. A. Zanella, A. Cunha Jr, A. M. Tusset, J. M. Balthazar**, *A Tutorial on the Simplification of Electromechanical Dynamic Models*, In: Balthazar, JM (eds), Nonlinear Vibrations Excited by Limited Power Sources. Mechanisms and Machine Science, vol 116. Springer, Cham, 2022. \u003ca href=\"https://doi.org/10.1007/978-3-030-96603-4_1\" target=\"_blank\"\u003eDOI\u003c/a\u003e \n\nPreprint available \u003ca href=\"https://hal.archives-ouvertes.fr/hal-03648813\" target=\"_blank\"\u003ehere\u003c/a\u003e. \n\n### Features\n- Simulates nonlinear dynamics of electromechanical systems\n- Includes full-order and reduced-order models\n- Considers mutual interaction between electrical and mechanical sub-systems in the full-order model\n- Decouples electrical and mechanical sub-systems in the reduced-order model\n- Calculates dimensionless groups for electromechanical systems\n- Provides easy-to-understand, well-commented code\n- Offers educational style code implementation for intuitive use\n\n### Usage\nTo started with **ElectroM**, follow these steps:\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/americocunhajr/ElectroM.git\n   ```\n2. Navigate to the code directory:\n   ```bash\n   cd ElectroM/ElectroM-1.0\n   ```\n3. To simulate both dynamical systems, execute:\n   ```bash\n   main_ElectroM_ivp\n   ```\n4. To perform Fourier analysis, execute:\n   ```bash\n   main_ElectroM_fourier\n   ```\n5. To compute dimensionless parameters value, execute:\n   ```bash\n   main_ElectroM_dimensionless\n   ```\n6. To compute dimensionless groups, execute:\n   ```bash\n   main_ElectroM_pi_groups\n   ```\n\n### Documentation\n**ElectroM** routines are thoroughly commented to explain their functionality to the user. Each routine includes a short description of its purpose and a list of inputs and outputs.\n\n### Reproducibility\nSimulations done with **ElectroM** are fully reproducible. You can access a reproducible capsule of the simulations on \u003ca href=\"https://codeocean.com/capsule/2532343/tree/v1\" target=\"_blank\"\u003eCodeOcean\u003c/a\u003e.\n\n### Authors\n- Americo Cunha Jr\n- Marcelo Pereira\n- Rafael Avanço\n- Angelo Marcelo Tusset\n- José Manoel Balthazar\n\n### Citing ElectroM\nIf you use **ElectroM** in your research, please cite the following publications:\n- *A. Cunha Jr, M. Pereira, R. Avanço, A. M. Tusset, and J. M. Balthazar, ElectroM: ElectroMechanical dynamic code, Software Impacts, 17:100533, 2023 https://doi.org/10.1016/j.simpa.2023.100533*\n- *A. Cunha Jr, M. Pereira, R. Avanço, A. M. Tusset, and J. M. Balthazar, On the modeling of nonlinear electromechanical systems, Meccanica, 57:2679-2697, 2022 https://doi.org/10.1007/s11012-022-01542-4*\n- *R. H. Avanço, D. A. Zanella, A. Cunha Jr, A. M. Tusset, J. M. Balthazar, A Tutorial on the Simplification of Electromechanical Dynamic Models, In: Balthazar, JM (eds), Nonlinear Vibrations Excited by Limited Power Sources. Mechanisms and Machine Science, vol 116. Springer, Cham, 2022 https://doi.org/10.1007/978-3-030-96603-4_1*\n\n```\n@article{CunhaJr2023ElectroM,\n   author  = {A. Cunha Jr and M. Pereira and R. Avanço and A. M. Tusset and J. M. Balthazar},\n   title   = \"{ElectroM: Electromechanical Dynamic Code}\",\n   journal = {Software Impacts},\n   year    = {2023},\n   volume  = {17},\n   pages   = {100533},\n   doi     = {10.1016/j.simpa.2023.100533},\n}\n```\n\n```\n@article{CunhaJr2022p2679,\n   author  = {A. Cunha Jr and M. Pereira and R. Avanço and A. M. Tusset and J. M. Balthazar},\n   title   = {On the reduction of nonlinear electromechanical systems},\n   journal = {Meccanica},\n   year    = {2022},\n   volume  = {57},\n   pages   = {2679-2697},\n   doi     = {10.1007/s11012-022-01542-4},\n}\n```\n\n```\n@Inbook{Avanço2022bookchap,\nauthor    = {Avan{\\c{c}}o, Rafael Henrique and Zanella, Danilo Antonio and Cunha, Americo and Tusset, Angelo Marcelo and Balthazar, Jose Manoel},\neditor    = {Balthazar, Jose Manoel},\ntitle     = \"{A Tutorial on the Simplification of Electromechanical Dynamic Models}\",\nbookTitle = {Nonlinear Vibrations Excited by Limited Power Sources},\nyear      = {2022},\npublisher = {Springer International Publishing},\naddress   = {Cham},\npages.    = {3--14},\ndoi       = {10.1007/978-3-030-96603-4_1},\n}\n```\n\n### License\n**ElectroM** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.\n\n\u003cimg src=\"logo/mit_license_red.png\" width=\"10%\"\u003e \n\n### Institutional support\n\n\u003cimg src=\"logo/logo_uerj.png\" width=\"13%\"\u003e \u0026nbsp; \u0026nbsp; \u003cimg src=\"logo/logo_senai_color.png\" width=\"25%\"\u003e \u0026nbsp; \u0026nbsp; \u003cimg src=\"logo/logo_ufma.png\" width=\"10%\"\u003e \u0026nbsp; \u0026nbsp;  \u003cimg src=\"logo/logo_utfpr_color.png\" width=\"20%\"\u003e \u0026nbsp; \u0026nbsp; \u003cimg src=\"logo/logo_unesp_color.png\" width=\"25%\"\u003e\n\n### Funding\n\n\u003cimg src=\"logo/faperj.png\" width=\"20%\"\u003e \u0026nbsp; \u0026nbsp; \u003cimg src=\"logo/cnpq.png\" width=\"20%\"\u003e \u0026nbsp; \u0026nbsp; \u003cimg src=\"logo/capes.png\" width=\"10%\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famericocunhajr%2Felectrom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famericocunhajr%2Felectrom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famericocunhajr%2Felectrom/lists"}