{"id":34552875,"url":"https://github.com/pyomeca/bioptim_gui","last_synced_at":"2025-12-24T08:05:04.713Z","repository":{"id":188335769,"uuid":"678535828","full_name":"pyomeca/bioptim_gui","owner":"pyomeca","description":"A gui to create and launch bioptim optimization program ","archived":false,"fork":false,"pushed_at":"2024-02-01T17:10:31.000Z","size":2293,"stargazers_count":2,"open_issues_count":3,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-20T00:07:07.433Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyomeca.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-08-14T19:27:59.000Z","updated_at":"2024-02-01T17:11:07.000Z","dependencies_parsed_at":"2024-02-01T19:05:59.472Z","dependency_job_id":null,"html_url":"https://github.com/pyomeca/bioptim_gui","commit_stats":null,"previous_names":["pyomeca/bioptim_gui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pyomeca/bioptim_gui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyomeca%2Fbioptim_gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyomeca%2Fbioptim_gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyomeca%2Fbioptim_gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyomeca%2Fbioptim_gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyomeca","download_url":"https://codeload.github.com/pyomeca/bioptim_gui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyomeca%2Fbioptim_gui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27998473,"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","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-12-24T08:04:24.925Z","updated_at":"2025-12-24T08:05:04.708Z","avatar_url":"https://github.com/pyomeca.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Bioptim GUI\n\nBioptim GUI is a graphical interface to use [bioptim](https://github.com/pyomeca/bioptim). It helps users to generate python script to solve Optimal Control Problems (OCP).\n\nBioptim GUI also offers an interface to generate code for solving trampoline acrobatics OCP.\nIt allows you to choose the number of somersault, the half-twists in each somersault, the position (straight, pike, tuck) and much more.\n\nThis guide will help you set up and run the Bioptim GUI application using Docker Compose and how to run it from source.\n\n## Status\n\n| Type          |Status                                                                                                                                                                |\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Code coverage | [![codecov](https://codecov.io/gh/Erdnaxela3/bioptim_gui/graph/badge.svg?token=BDDRIU6QO5)](https://codecov.io/gh/Erdnaxela3/bioptim_gui)                                   |\n| Code climate  | \u003ca href=\"https://codeclimate.com/github/Erdnaxela3/bioptim_gui/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/1f0c8a0756000c5764d2/maintainability\" /\u003e\u003c/a\u003e |\n\n# Running Bioptim GUI on Linux(Ubuntu) with Docker Compose\n\n## Prerequisites\n\n- Docker Desktop installed on your system ([Install Docker](\u003chttps://www.docker.com/products/docker-desktop/\u003e))\n\n## Steps\n\n### Allow X Server connections\n\nAllow Docker to access your X Server by executing the following command in your terminal:\nThis allows the graphical interface to show up on your screen.\n\n```bash\nxhost +local:docker\n```\n\n### Getting the app files\n\n- Clone the repository:\n\n```bash\ngit clone https://github.com/Erdnaxela3/bioptim_gui.git\n```\n\n- Navigate to the project directory:\n\n ```bash\ncd bioptim-gui\n```\n\n### Downloading 'ma57' solver\n\n[The linear solvers from the HSL Mathematical Software Library](http://www.hsl.rl.ac.uk/index.html) with install instructions [here](https://github.com/casadi/casadi/wiki/Obtaining-HSL).\n\n- copy libgfortran.so.4 and libhsl.so inside bioptim_gui/gui\n\n#### Note\n\nYou will not be able to run code inside the GUI without the solver.\n\n### Building the application (first time)\n\n```bash\ndocker-compose build\n```\n\n### Run the application\n\n- Run the application using Docker Compose:\n\n```bash\ndocker-compose up\n```\n\n### Stopping the application\n\nTo stop the application, press `Ctrl + C` in the terminal where `docker-compose up` is running.\n\n### Notes\n\n- The application may take some time to start up.\n- Ensure the X Server is running before executing `docker-compose up`.\n- default .bioMod are provided. Users can add more models inside bioptim_gui/models, but this will necessit re-building the application.\n\n# Running without Docker Compose and developping\n\n## Prerequisites\n\n- [Flutter](https://docs.flutter.dev/get-started/install) installed.\n- Python \u003e=3.11.5 environment (using [Anaconda3](https://docs.anaconda.com/free/anaconda/install/index.html) or [Miniconda3](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html)) with [bioptim 3.1.0](https://github.com/pyomeca/bioptim) installed.\n\nTo create a bioptim environment:\n\nOptional, use libmamba solver to quicken the process:\n\n```bash\nconda install -n base conda-libmamba-solver\nconda config --set solver libmamba\n```\n\n```bash\ngit clone https://github.com/pyomeca/bioptim.git\ncd bioptim\ngit checkout a3ede0e7921df909fcdf1fb92d536628594dba04\nconda env create -f environment.yml\nconda activate bioptim\npython setup install\n```\n\n#### Downloading 'ma57' solver\n\n[The linear solvers from the HSL Mathematical Software Library](http://www.hsl.rl.ac.uk/index.html) with install instructions [here](https://github.com/casadi/casadi/wiki/Obtaining-HSL). The solvers will be needed in order to run the generated code.\n\nCopy libgfortran.so.4 and libhsl.so in your bioptim env:\n\nFor anaconda3, it should be:\n\n```bash\ncp libfortran.so.4 ~/anaconda3/envs/bioptim/lib/\ncp libhsl.so ~/anaconda3/envs/bioptim/lib/\n```\n\nIf this didn't work, find your bioptim env path:\n\n```bash\nconda activate bioptim\nwhich python\n```\n\n## Clone the repo\n\n- Clone the bioptim GUI repository:\n\n```bash\ngit clone https://github.com/Erdnaxela3/bioptim_gui.git\ncd bioptim_gui\n```\n\n## Running the API\n\n- Install the dependencies\n\n```bash\ncd api\npip install -r requirements.txt\n```\n\n```bash\nuvicorn bioptim_gui_api.main:app --reload \n```\n\n### Documentation\n\nBioptim GUI API should now be accessible at \u003chttp://localhost:8000\u003e in your web browser.\nDocumentation on API is available  at \u003chttp://localhost:8000/docs\u003e\n\n## Running the GUI\n\n- In another terminal\n\n```bash\ncd gui\nflutter run\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyomeca%2Fbioptim_gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyomeca%2Fbioptim_gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyomeca%2Fbioptim_gui/lists"}