{"id":25977076,"url":"https://github.com/aenarete/kiteviewers.jl","last_synced_at":"2025-03-05T04:30:16.383Z","repository":{"id":40329276,"uuid":"483687034","full_name":"aenarete/KiteViewers.jl","owner":"aenarete","description":"3D viewer for airborne wind energy systems","archived":false,"fork":false,"pushed_at":"2024-11-18T11:07:40.000Z","size":953,"stargazers_count":5,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-21T10:46:45.547Z","etag":null,"topics":["airborne","energy","kite","wind","windenergy"],"latest_commit_sha":null,"homepage":"","language":"Julia","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/aenarete.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-04-20T14:25:15.000Z","updated_at":"2024-12-09T14:54:29.000Z","dependencies_parsed_at":"2024-03-18T13:43:45.418Z","dependency_job_id":"12021753-01d9-4e43-87d6-40a64971f6b5","html_url":"https://github.com/aenarete/KiteViewers.jl","commit_stats":{"total_commits":133,"total_committers":2,"mean_commits":66.5,"dds":"0.18796992481203012","last_synced_commit":"c126e3f3498cb4154d7c942f3349a12354f26211"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aenarete%2FKiteViewers.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aenarete%2FKiteViewers.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aenarete%2FKiteViewers.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aenarete%2FKiteViewers.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aenarete","download_url":"https://codeload.github.com/aenarete/KiteViewers.jl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241966433,"owners_count":20050316,"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":["airborne","energy","kite","wind","windenergy"],"created_at":"2025-03-05T04:30:15.063Z","updated_at":"2025-03-05T04:30:16.374Z","avatar_url":"https://github.com/aenarete.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KiteViewers\n[![Build Status](https://github.com/aenarete/KiteViewers.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/aenarete/KiteViewers.jl/actions/workflows/CI.yml?query=branch%3Amain)\n[![Coverage](https://codecov.io/gh/aenarete/KiteViewers.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/aenarete/KiteViewers.jl)\n\nThis package provides different kind of 2D and 3D viewers for kite power system.\n\nIt is part of Julia Kite Power Tools, which consist of the following packages:\n\u003cp align=\"center\"\u003e\u003cimg src=\"./docs/kite_power_tools.png\" width=\"500\" /\u003e\u003c/p\u003e\n\n## What to install\nIf you want to run simulations and see the results in 3D, please install the meta package  [KiteSimulators](https://github.com/aenarete/KiteSimulators.jl) . If you just want to replay log files\nor implement a real-time viewer for a system outside of Julia this package will be sufficient. When you have KiteSimulators installed, please replace\nany statement `using KiteViewers` in the examples with `using KiteSimulators`.\n\n## Installation\nDownload and install [Julia 1.10](https://ufechner7.github.io/2024/08/09/installing-julia-with-juliaup.html) or later, if you haven't already.\nMake sure you have the package `TestEnv` in your global environment if you want to run the examples. If you are not sure, run:\n```bash\njulia -e 'using Pkg; Pkg.add(\"TestEnv\")'\n```\nIf you don't have a project yet, create one with:\n```bash\nmkdir MyProject\ncd MyProject\njulia --project=\".\"\n```\nand then add the package `KiteViewers` to your project by executing:\n```julia\nusing Pkg\npkg\"add KiteViewers\"\n``` \nat the Julia prompt.\n\nYou can install the examples with:\n```julia\nusing KiteViewers\nKiteViewers.install_examples()\n```\nand get a menu with the examples by typing:\n```julia\nmenu()\n```\n\nYou can run the unit tests with the command:\n```julia\nusing Pkg\npkg\"test KiteViewers\"\n```\nThis package should work on Linux, Windows and Mac. If you find a bug, please file an issue.\n\n## Installation from git (for package developers)\nFirst, fork this repository using the \"Fork\" button on the top of the website. Then, clone\nyour fork, e.g.:\n```bash\ngit clone https://github.com/USERNAME/KiteViewers.jl\n```\nwhere you have to replace USERNAME with your github user name.\nThen, run the installation script:\n```bash\ncd KiteViewers.jl\ncd bin\n./install\ncd ..\n```\nThe install script creates a version of `Manifest.toml` that works both with the normal project \nand with the test environment, needed to run the examples.\nTo launch Julia, type:\n```bash\n./bin/run_julia\n```\nFor more comfort, add this line to your `.bashrc` file:\n```bash\nalias jl='./bin/run_julia'\n```\nThen you can launch Julia, using the `run_julia` script just by typing `jl`.\n\n## Exported types\n```julia\nViewer3D\nAbstractKiteViewer\nAKV\n```\nAKV is just the short form of AbstractKiteViewer, Viewer3D the first implementation of it.\n\nUsage:\n```julia\nshow_kite=true\nviewer=Viewer3D(show_kite)\n```\n\n## Exported functions\n```julia\nclear_viewer(kv::AKV; stop_=true)\nupdate_system(kv::AKV, state::SysState; scale=1.0, kite_scale=3.5)\nsave_png(kv::AKV; filename=\"video\", index = 1)\nstop(kv::AKV)\nset_status(kv::AKV, status_text)\n```\n\n## Examples\n```julia\nusing KiteViewers\nviewer=Viewer3D(true);\n```\n\nAfter some time a window with the 3D view of a kite power system should pop up.\nIf you keep the window open and execute the following code:\n\n```julia\nusing KiteUtils\nsegments=6\nstate=demo_state(segments+1)\nupdate_system(viewer, state)\n```\n\nyou should see a kite on a tether.\n\u003cp align=\"center\"\u003e\u003cimg src=\"./kite_1p.png\" width=\"500\" /\u003e\u003c/p\u003e\n\nThe same example, but using the 4 point kite model:\n\n```julia\nusing KiteViewers, KiteUtils\nviewer=Viewer3D(true);\nsegments=6\nstate=demo_state_4p(segments+1)\nupdate_system(viewer, state, kite_scale=0.25)\n```\n\u003cp align=\"center\"\u003e\u003cimg src=\"./kite_4p.png\" width=\"500\" /\u003e\u003c/p\u003e\n\nYou can find more examples in the folder examples.\n\n## Advanced usage\nFor more examples see: [KiteSimulators](https://github.com/aenarete/KiteSimulators.jl)\n\n## License\nThis project is licensed under the MIT License. Please see the below WAIVER in association with the license.\n\n## WAIVER\nTechnische Universiteit Delft hereby disclaims all copyright interest in the package “KiteSimulators.jl” (simulators for airborne wind energy systems) written by the Author(s).\n\nProf.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering\n\n## See also\n- [Research Fechner](https://research.tudelft.nl/en/publications/?search=Uwe+Fechner\u0026pageSize=50\u0026ordering=rating\u0026descending=true) for the scientic background of this code\n- The meta-package  [KiteSimulators](https://github.com/aenarete/KiteSimulators.jl)\n- the packages [KiteModels](https://github.com/ufechner7/KiteModels.jl) and [WinchModels](https://github.com/aenarete/WinchModels.jl) and [KitePodModels](https://github.com/aenarete/KitePodModels.jl) and [AtmosphericModels](https://github.com/aenarete/AtmosphericModels.jl)\n- the package [KiteUtils](https://github.com/ufechner7/KiteUtils.jl) and [KiteControllers](https://github.com/aenarete/KiteControllers.jl)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faenarete%2Fkiteviewers.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faenarete%2Fkiteviewers.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faenarete%2Fkiteviewers.jl/lists"}