# Everyone should be able to configure ArduPilot for their vehicles
<!--
SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
SPDX-License-Identifier: GPL-3.0-or-later
-->
| Lint | Quality | Test | Deploy | Maintain |
| ---- | ------- | ---- | ------ | -------- |
| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/pylint.yml) | [](https://app.codacy.com/gh/amilcarlucas/MethodicConfigurator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/unit-tests.yml) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/pages/pages-build-deployment) | [](http://isitmaintained.com/project/ArduPilot/MethodicConfigurator) |
| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/ruff.yml) | [](https://www.bestpractices.dev/projects/9101) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/unittests.yml) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/python-publish.yml) | [](http://isitmaintained.com/project/ArduPilot/MethodicConfigurator) |
| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/mypy.yml) | [](https://snyk.io/test/github/amilcarlucas/MethodicConfigurator) | [](https://codecov.io/github/amilcarlucas/MethodicConfigurator) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/windows_build.yml) | |
| | [](https://codeclimate.com/github/amilcarlucas/MethodicConfigurator) | [](https://scan.coverity.com/projects/ardupilot-methodic-configurator) | | |
Amilcar Lucas's ArduPilot Methodic Configurator is a software that semi-automates a [clear, proven and safe configuration sequence for ArduCopter drones](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter).
- **clear**: the sequence is linear, executed one step at the time with no hidden complex dependencies
- **proven**: the software has been used by hundreds of ArduPilot developers and users. From beginners to advanced. On big and small vehicles.
- **safe**: the sequence reduces trial-and-error and aims at reducing the amount of flights required to configure the vehicle
It provides a graphical user interface (GUI) for managing and visualizing ArduPilot parameters, parameter files and documentation.
We are working on extending it to [ArduPlane](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduPlane), [Heli](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Heli) and [Rover](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Rover) vehicles.
But for those it is still very incomplete.
## Usage
There is a [Quick-start guide](QUICKSTART.md) and a more detailed [Usermanual](USERMANUAL.md)
## MS Windows Installation
Download the [latest MethodicConfiguratorSetup-x.x.x.exe installer file](https://github.com/ArduPilot/MethodicConfigurator/releases/tag/latest).
## Linux Installation
### Older distros without venv
Install [python pip](https://pypi.org/project/pip/). Then do:
```bash
pip install -U MethodicConfigurator
```
To run it do:
```bash
ardupilot_methodic_configurator
```
### Newer distros with venv
```bash
python -m venv .ardupilot_methodic_configurator_venv
source .ardupilot_methodic_configurator_venv/bin/activate
python -m pip install --upgrade pip
pip install MethodicConfigurator
```
To run it do:
```bash
source .ardupilot_methodic_configurator_venv/bin/activate
ardupilot_methodic_configurator
```
## MacOS Installation
Install [git](https://git-scm.com/) and [python](https://www.python.org/downloads/). Then do:
```bash
git clone https://github.com/ArduPilot/MethodicConfigurator.git
cd MethodicConfigurator
./install_macos.sh
```
## Support and Contributing
Please feel free to submit [issues](https://github.com/ArduPilot/MethodicConfigurator/issues) or [pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls). More information is available on the [contributing and support](CONTRIBUTING.md) page.
## Software architecture
To meet the [Software requirements](ARCHITECTURE.md#software-requirements) a [software architecture](ARCHITECTURE.md#the-software-architecture) was designed and implemented.
## Code of conduct
To use and develop this software you must obey the [ArduPilot Methodic Configurator Code of Conduct](CODE_OF_CONDUCT.md).
## License
This project is licensed under the [GNU General Public License v3.0](LICENSE.md).
It builds upon other [open-source software packages](credits/CREDITS.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "MethodicConfigurator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Amilcar do Carmo Lucas <amilcar.lucas@iav.de>",
"keywords": "ArduPilot, Configuration, SCM, Methodic, ArduCopter, ArduPlane, ArduRover, ArduSub",
"author": null,
"author_email": "Amilcar do Carmo Lucas <amilcar.lucas@iav.de>",
"download_url": null,
"platform": null,
"description": "# Everyone should be able to configure ArduPilot for their vehicles\n\n<!--\nSPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>\n\nSPDX-License-Identifier: GPL-3.0-or-later\n-->\n\n| Lint | Quality | Test | Deploy | Maintain |\n| ---- | ------- | ---- | ------ | -------- |\n| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/pylint.yml) | [](https://app.codacy.com/gh/amilcarlucas/MethodicConfigurator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/unit-tests.yml) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/pages/pages-build-deployment) | [](http://isitmaintained.com/project/ArduPilot/MethodicConfigurator) |\n| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/ruff.yml) | [](https://www.bestpractices.dev/projects/9101) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/unittests.yml) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/python-publish.yml) | [](http://isitmaintained.com/project/ArduPilot/MethodicConfigurator) |\n| [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/mypy.yml) | [](https://snyk.io/test/github/amilcarlucas/MethodicConfigurator) | [](https://codecov.io/github/amilcarlucas/MethodicConfigurator) | [](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/windows_build.yml) | |\n| | [](https://codeclimate.com/github/amilcarlucas/MethodicConfigurator) | [](https://scan.coverity.com/projects/ardupilot-methodic-configurator) | | |\n\nAmilcar Lucas's ArduPilot Methodic Configurator is a software that semi-automates a [clear, proven and safe configuration sequence for ArduCopter drones](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter).\n\n- **clear**: the sequence is linear, executed one step at the time with no hidden complex dependencies\n- **proven**: the software has been used by hundreds of ArduPilot developers and users. From beginners to advanced. On big and small vehicles.\n- **safe**: the sequence reduces trial-and-error and aims at reducing the amount of flights required to configure the vehicle\n\n\n\nIt provides a graphical user interface (GUI) for managing and visualizing ArduPilot parameters, parameter files and documentation.\n\n\n\nWe are working on extending it to [ArduPlane](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduPlane), [Heli](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Heli) and [Rover](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Rover) vehicles.\nBut for those it is still very incomplete.\n\n## Usage\n\nThere is a [Quick-start guide](QUICKSTART.md) and a more detailed [Usermanual](USERMANUAL.md)\n\n## MS Windows Installation\n\nDownload the [latest MethodicConfiguratorSetup-x.x.x.exe installer file](https://github.com/ArduPilot/MethodicConfigurator/releases/tag/latest).\n\n## Linux Installation\n\n### Older distros without venv\n\nInstall [python pip](https://pypi.org/project/pip/). Then do:\n\n```bash\npip install -U MethodicConfigurator\n```\n\nTo run it do:\n\n```bash\nardupilot_methodic_configurator\n```\n\n### Newer distros with venv\n\n```bash\npython -m venv .ardupilot_methodic_configurator_venv\nsource .ardupilot_methodic_configurator_venv/bin/activate\npython -m pip install --upgrade pip\npip install MethodicConfigurator\n```\n\nTo run it do:\n\n```bash\nsource .ardupilot_methodic_configurator_venv/bin/activate\nardupilot_methodic_configurator\n```\n\n## MacOS Installation\n\nInstall [git](https://git-scm.com/) and [python](https://www.python.org/downloads/). Then do:\n\n```bash\ngit clone https://github.com/ArduPilot/MethodicConfigurator.git\ncd MethodicConfigurator\n./install_macos.sh\n```\n\n## Support and Contributing\n\nPlease feel free to submit [issues](https://github.com/ArduPilot/MethodicConfigurator/issues) or [pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls). More information is available on the [contributing and support](CONTRIBUTING.md) page.\n\n## Software architecture\n\nTo meet the [Software requirements](ARCHITECTURE.md#software-requirements) a [software architecture](ARCHITECTURE.md#the-software-architecture) was designed and implemented.\n\n## Code of conduct\n\nTo use and develop this software you must obey the [ArduPilot Methodic Configurator Code of Conduct](CODE_OF_CONDUCT.md).\n\n## License\n\nThis project is licensed under the [GNU General Public License v3.0](LICENSE.md).\nIt builds upon other [open-source software packages](credits/CREDITS.md)\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A clear configuration sequence for ArduPilot vehicles",
"version": "0.9.15",
"project_urls": {
"changelog": "https://github.com/ArduPilot/MethodicConfigurator/releases",
"chat": "https://discord.com/invite/ArduPilot",
"documentation": "https://github.com/ArduPilot/MethodicConfigurator/blob/master/USERMANUAL.md",
"download": "https://github.com/ArduPilot/MethodicConfigurator/releases",
"forum": "https://discuss.ardupilot.org/t/new-ardupilot-methodic-configurator-gui/115038/",
"homepage": "https://github.com/ArduPilot/MethodicConfigurator",
"issues": "https://github.com/ArduPilot/MethodicConfigurator/issues",
"source": "https://github.com/ArduPilot/MethodicConfigurator"
},
"split_keywords": [
"ardupilot",
" configuration",
" scm",
" methodic",
" arducopter",
" arduplane",
" ardurover",
" ardusub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f60a8eb5e12b2dbce57255b8915e24cc35605704b1ff51661cf40ba4c0a13c02",
"md5": "f212320eb16207318325ecef099dcd72",
"sha256": "ae0a8fb163147d8a40bb0d53f0f5cbeff830d1f443ef47a5f9f3093999bb8634"
},
"downloads": -1,
"filename": "MethodicConfigurator-0.9.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f212320eb16207318325ecef099dcd72",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9966690,
"upload_time": "2024-11-22T12:03:00",
"upload_time_iso_8601": "2024-11-22T12:03:00.515444Z",
"url": "https://files.pythonhosted.org/packages/f6/0a/8eb5e12b2dbce57255b8915e24cc35605704b1ff51661cf40ba4c0a13c02/MethodicConfigurator-0.9.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 12:03:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ArduPilot",
"github_project": "MethodicConfigurator",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "methodicconfigurator"
}
JSON
