{"id":25800152,"url":"https://github.com/caisilus/masters_diploma","last_synced_at":"2025-10-24T19:10:20.878Z","repository":{"id":279282743,"uuid":"929560324","full_name":"caisilus/masters_diploma","owner":"caisilus","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-12T14:29:53.000Z","size":48,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-27T08:46:26.520Z","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/caisilus.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-08T20:38:18.000Z","updated_at":"2025-07-12T14:29:57.000Z","dependencies_parsed_at":"2025-03-16T18:47:38.555Z","dependency_job_id":"1a274ae0-73e4-4464-b29f-218a14416a69","html_url":"https://github.com/caisilus/masters_diploma","commit_stats":null,"previous_names":["caisilus/masters_diploma"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/caisilus/masters_diploma","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caisilus%2Fmasters_diploma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caisilus%2Fmasters_diploma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caisilus%2Fmasters_diploma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caisilus%2Fmasters_diploma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caisilus","download_url":"https://codeload.github.com/caisilus/masters_diploma/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caisilus%2Fmasters_diploma/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001290,"owners_count":26083058,"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-10-09T02:00:07.460Z","response_time":59,"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-02-27T15:59:07.846Z","updated_at":"2025-10-09T11:18:06.901Z","avatar_url":"https://github.com/caisilus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# О проекте\n\nЦель проекта - автоматическая генерация полигональных сеток представительных объемов заданной структуры с гибкой настройкой параметров. Для интеграции с расчетными системами на основе метода конечных элементов модуль генерации сеток выделен в микросервис, но возможно использование также и в виде CLI-утилиты\n\n# Установка зависимостей\n\n```bash\npip install -r requirements.txt\n```\n\nДля запуска через Procfile:\n\n```bash\ngem install foreman\n```\n\nТакже для работы celery нужен Redis. Устанавливать по [гайду из документации Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/)\n\n# Использование\n\n## CLI-утилита\n\n### Ветвистая структура\n\n```bash\npython generate_mesh.py [опции]\n```\n\n#### ⚙️ Основные параметры:\n\n| Параметр               | Описание                                      | По умолчанию            |\n|------------------------|-----------------------------------------------|--------------------------|\n| `--r-root`             | Радиус корня                                  | `0.5`                    |\n| `--h-root`             | Высота корня                                  | `4.0`                    |\n| `--r-branch`           | Радиус ветвей                                 | `0.4`                    |\n| `--h-branch`           | Высота ветвей                                 | `3.0`                    |\n| `--num-branches`       | Кол-во ветвей                                 | `4`                      |\n| `--angle`              | Угол между ветвями (в градусах)               | `30`                     |\n| `--mesh-size`          | Размер элементов сетки                        | `1.0`                    |\n| `--output`             | Имя выходного `.msh` файла                    | `branch_element.msh`     |\n| `--export-formats`     | Экспорт в доп. форматы (`stl,obj,vtk,...`)    | _не указано_             |\n| `--no-gui`             | Не запускать GUI Gmsh                         | _false_                  |\n| `--log-file`           | Путь к лог-файлу                              | _не указано_             |\n| `--config`             | Конфигурационный файл `.yaml` или `.json`    | _не указано_             |\n\n\n#### 📝 Пример конфигурации (config.yaml)\n\n```yaml\nr_root: 0.6\nh_root: 5.0\nnum_branches: 6\nangle: 25\nmesh_size: 0.8\noutput: \"cool_branch.msh\"\nexport_formats: \"stl,obj\"\nno_gui: true\nlog_file: \"generation.log\"\n```\n\n#### 🧪 Примеры запуска\n\nЗапуск с параметрами из командной строки:\n```bash\npython branching_element_cli.py --r-root 0.6 --num-branches 6 --angle 45 --no-gui --output result.msh\n```\n\nЗапуск с конфигурационным файлом:\n```bash\npython branching_element_cli.py --config config.yaml\n```\n\n### Пористый материал\n\n#### ⚙️ Основные параметры:\n\n| Параметр               | Описание                                      | По умолчанию            |\n|------------------------|-----------------------------------------------|--------------------------|\n| `--spheres_count`       | Кол-во сфер                                 | *не указано*\n| `--r`              | радиус сферы | *не указано* |\n| `--allowance`              | Минимальное расстояние между границами сфер | *не указано* |\n| `--mesh-size`          | Размер элементов сетки                        | `1.0`                    |\n| `--output`             | Имя выходного `.msh` файла                    | `porous.msh`     |\n| `--no-gui`             | Не запускать GUI Gmsh                         | _false_                  |\n| `--config`             | Конфигурационный файл `.yaml` или `.json`    | _не указано_             |\n\n\n#### 📝 Пример конфигурации (config.yaml)\n\n```yaml\nspheres_count: 15\nr: 0.1\nallowance: 0.02\nmesh_size: 0.8\noutput: \"cool_branch.msh\"\nno_gui: true\n```\n\n#### 🧪 Примеры запуска\n\nЗапуск с параметрами из командной строки:\n```bash\npython porous_material_cli.py --r 0.1 --speheres_count 6 --allowance 0.1 --no-gui --output result.msh\n```\n\nЗапуск с конфигурационным файлом:\n```bash\npython porous_material_cli.py --config config.yaml\n```\n\n## Микросервис\n\n\u003e `localhost:8080/docs` - API-документация HTTP-сервиса для генерации сеток\n\nВ проекте используется аутентификация по токену в хедере API-KEY, поэтому для тестов необходимо добавлять этот токен во все запросы.\nКорректное значение задается переменной окружения API_KEY, поэтому её необходимо устанавливать перед запуском сервера\n\n### Запуск через Docker\n\nМожно просто запустить docker-compose со стандартными настройками. Корректный API-KEY в этом случае `123` (поменять для production !)\n```bash\ndocker-compose up\n```\n\nПри необходимости проверить webhook, можно отдельно запустить test_webhook сервер(тут процесс через Docker не налажен пока):\n\n```bash\npython -m uvicorn test_webhook:app --reload --port=8001\n```\n\nТогда в запросе `/generate` нужно будет указывать webhook_url: http://localhost:8001/webhook\n\n### Запуск без Docker\n\n#### Запуск через foreman\n\nЕсли установлен `foreman`, можно запускать все сервисы через\n\n```bash\nAPI_KEY=\u003cваш ключ\u003e foreman start\n```\n\n#### Запуск команд вручную\nАльтернативно, можно запускать их по одному:\n\n1. Запуск основного сервера\n\n```bash\nAPI_KEY=\u003cваш ключ\u003e python -m uvicorn main:app --reload\n```\n\n2. Запуск celery\n\n```bash\ncelery -A tasks.celery_app worker --loglevel=info\n```\n\n3. (Опционально) запуск сервера для тестового веб-хука на порту 8001\n\n```bash\npython -m uvicorn test_webhook:app --reload --port=8001\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaisilus%2Fmasters_diploma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaisilus%2Fmasters_diploma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaisilus%2Fmasters_diploma/lists"}