[{"data":1,"prerenderedAt":562},["ShallowReactive",2],{"branding":3,"navigation":11,"social":38,"\u002Fdocs\u002Foverview\u002Finstallation":57,"\u002Fdocs\u002Foverview\u002Finstallation-python":472,"\u002Fdocs\u002Foverview\u002Finstallation-surround":473,"docs-navigation":481,"compas-version":561},{"id":4,"title":5,"description":6,"extension":7,"meta":8,"stem":9,"__hash__":10},"branding\u002Fbranding.yml","COMPAS","The Progressive Python Framework for AEC","yml",{},"branding","RZe_zlUXQhPN3ap5X6d0zUmiqalxe1ZFVRnIsmTB9VU",{"id":12,"title":13,"extension":7,"items":14,"meta":35,"stem":36,"__hash__":37},"navigation\u002Fnavigation.yml","Main Navigation",[15,19,23,27,31],{"label":16,"icon":17,"to":18},"Docs","i-heroicons-book-open","\u002Fdocs\u002Foverview\u002Fintroduction",{"label":20,"icon":21,"to":22},"Packages","i-heroicons-puzzle-piece","\u002Fpackages",{"label":24,"icon":25,"to":26},"Association","i-heroicons-users","\u002Fassociation",{"label":28,"to":29,"icon":30},"News","\u002Fnews","i-heroicons-newspaper",{"label":32,"icon":33,"to":34},"Forum","i-heroicons-chat-bubble-left-right","https:\u002F\u002Fforum.compas-framework.org\u002F",{},"navigation","0jaKadsuS1w-R-2CifQeF-7No6HqrVyF7jIP80oFYoM",{"id":39,"title":40,"extension":7,"items":41,"meta":54,"stem":55,"__hash__":56},"social\u002Fsocial.yml","Social Media",[42,46,50],{"label":43,"to":44,"icon":45},"GitHub","https:\u002F\u002Fgithub.com\u002Fcompas-dev","i-simple-icons-github",{"label":47,"to":48,"icon":49},"X","https:\u002F\u002Fx.com\u002Fcompas_dev","i-simple-icons-x",{"label":51,"to":52,"icon":53},"LinkedIn","https:\u002F\u002Fwww.linkedin.com\u002Fcompany\u002Fcompas-association","i-simple-icons-linkedin",{},"social","495juwkNU0wtE_8lwERDZNWQES5uWYuMK_Wa6cQ9Wxg",{"id":58,"title":59,"body":60,"description":463,"extension":464,"headline":465,"meta":466,"navigation":467,"path":468,"seo":469,"stem":470,"__hash__":471},"docs\u002Fdocs\u002F1.overview\u002F2.installation.md","Installation",{"type":61,"value":62,"toc":457},"minimark",[63,81,436,453],[64,65,66,67,74,75,80],"p",{},"COMPAS is a regular Python package on ",[68,69,73],"a",{"href":70,"rel":71},"https:\u002F\u002Fpypi.org\u002Fproject\u002Fcompas\u002F",[72],"nofollow","PyPI"," and ",[68,76,79],{"href":77,"rel":78},"https:\u002F\u002Fanaconda.org\u002Fconda-forge\u002Fcompas",[72],"conda-forge",". Pick one package manager and use it on every step below; the tabs stay in sync.",[82,83,84,89,98,137,141,294,298,356,362,366],"steps",{},[85,86,88],"h3",{"id":87},"requirements","Requirements",[64,90,91,92,97],{},"You need a ",[68,93,96],{"href":94,"rel":95},"https:\u002F\u002Fdevguide.python.org\u002Fversions\u002F",[72],"supported Python version"," and one of these package managers:",[99,100,101,110,126],"ul",{},[102,103,104,109],"li",{},[68,105,108],{"href":106,"rel":107},"https:\u002F\u002Fdocs.astral.sh\u002Fuv\u002Fgetting-started\u002Finstallation\u002F",[72],"uv",", which is fast and manages Python for you. We recommend it.",[102,111,112,117,118,74,122,125],{},[68,113,116],{"href":114,"rel":115},"https:\u002F\u002Fconda-forge.org\u002Fdownload\u002F",[72],"Miniforge",", which provides both ",[119,120,121],"code",{},"mamba",[119,123,124],{},"conda",".",[102,127,128,133,134,125],{},[68,129,132],{"href":130,"rel":131},"https:\u002F\u002Fwww.python.org\u002Fdownloads\u002F",[72],"Python",", which includes ",[119,135,136],{},"pip",[85,138,140],{"id":139},"install-compas","Install COMPAS",[142,143,145,189,225,254],"code-group",{"sync":144},"pm",[146,147,152],"pre",{"className":148,"code":149,"filename":108,"language":150,"meta":151,"style":151},"language-bash shiki shiki-themes github-dark","uv init my-project\ncd my-project\nuv add compas\n","bash","",[119,153,154,169,178],{"__ignoreMap":151},[155,156,159,162,166],"span",{"class":157,"line":158},"line",1,[155,160,108],{"class":161},"svObZ",[155,163,165],{"class":164},"sU2Wk"," init",[155,167,168],{"class":164}," my-project\n",[155,170,172,176],{"class":157,"line":171},2,[155,173,175],{"class":174},"sDLfK","cd",[155,177,168],{"class":164},[155,179,181,183,186],{"class":157,"line":180},3,[155,182,108],{"class":161},[155,184,185],{"class":164}," add",[155,187,188],{"class":164}," compas\n",[146,190,192],{"className":148,"code":191,"filename":121,"language":150,"meta":151,"style":151},"mamba create -n compas-dev -c conda-forge compas\nmamba activate compas-dev\n",[119,193,194,215],{"__ignoreMap":151},[155,195,196,198,201,204,207,210,213],{"class":157,"line":158},[155,197,121],{"class":161},[155,199,200],{"class":164}," create",[155,202,203],{"class":174}," -n",[155,205,206],{"class":164}," compas-dev",[155,208,209],{"class":174}," -c",[155,211,212],{"class":164}," conda-forge",[155,214,188],{"class":164},[155,216,217,219,222],{"class":157,"line":171},[155,218,121],{"class":161},[155,220,221],{"class":164}," activate",[155,223,224],{"class":164}," compas-dev\n",[146,226,228],{"className":148,"code":227,"filename":124,"language":150,"meta":151,"style":151},"conda create -n compas-dev -c conda-forge compas\nconda activate compas-dev\n",[119,229,230,246],{"__ignoreMap":151},[155,231,232,234,236,238,240,242,244],{"class":157,"line":158},[155,233,124],{"class":161},[155,235,200],{"class":164},[155,237,203],{"class":174},[155,239,206],{"class":164},[155,241,209],{"class":174},[155,243,212],{"class":164},[155,245,188],{"class":164},[155,247,248,250,252],{"class":157,"line":171},[155,249,124],{"class":161},[155,251,221],{"class":164},[155,253,224],{"class":164},[146,255,257],{"className":148,"code":256,"filename":136,"language":150,"meta":151,"style":151},"python -m venv .venv\nsource .venv\u002Fbin\u002Factivate  # Windows: .venv\\Scripts\\activate\npip install compas\n",[119,258,259,273,285],{"__ignoreMap":151},[155,260,261,264,267,270],{"class":157,"line":158},[155,262,263],{"class":161},"python",[155,265,266],{"class":174}," -m",[155,268,269],{"class":164}," venv",[155,271,272],{"class":164}," .venv\n",[155,274,275,278,281],{"class":157,"line":171},[155,276,277],{"class":174},"source",[155,279,280],{"class":164}," .venv\u002Fbin\u002Factivate",[155,282,284],{"class":283},"sAwPA","  # Windows: .venv\\Scripts\\activate\n",[155,286,287,289,292],{"class":157,"line":180},[155,288,136],{"class":161},[155,290,291],{"class":164}," install",[155,293,188],{"class":164},[85,295,297],{"id":296},"verify-the-installation","Verify the installation",[142,299,300,319,332,344],{"sync":144},[146,301,303],{"className":148,"code":302,"filename":108,"language":150,"meta":151,"style":151},"uv run python -m compas\n",[119,304,305],{"__ignoreMap":151},[155,306,307,309,312,315,317],{"class":157,"line":158},[155,308,108],{"class":161},[155,310,311],{"class":164}," run",[155,313,314],{"class":164}," python",[155,316,266],{"class":174},[155,318,188],{"class":164},[146,320,322],{"className":148,"code":321,"filename":121,"language":150,"meta":151,"style":151},"python -m compas\n",[119,323,324],{"__ignoreMap":151},[155,325,326,328,330],{"class":157,"line":158},[155,327,263],{"class":161},[155,329,266],{"class":174},[155,331,188],{"class":164},[146,333,334],{"className":148,"code":321,"filename":124,"language":150,"meta":151,"style":151},[119,335,336],{"__ignoreMap":151},[155,337,338,340,342],{"class":157,"line":158},[155,339,263],{"class":161},[155,341,266],{"class":174},[155,343,188],{"class":164},[146,345,346],{"className":148,"code":321,"filename":136,"language":150,"meta":151,"style":151},[119,347,348],{"__ignoreMap":151},[155,349,350,352,354],{"class":157,"line":158},[155,351,263],{"class":161},[155,353,266],{"class":174},[155,355,188],{"class":164},[64,357,358,359,125],{},"This prints the installed version, for example ",[360,361],"compas-version",{},[85,363,365],{"id":364},"update-compas","Update COMPAS",[142,367,368,385,403,420],{"sync":144},[146,369,371],{"className":148,"code":370,"filename":108,"language":150,"meta":151,"style":151},"uv sync --upgrade-package compas\n",[119,372,373],{"__ignoreMap":151},[155,374,375,377,380,383],{"class":157,"line":158},[155,376,108],{"class":161},[155,378,379],{"class":164}," sync",[155,381,382],{"class":174}," --upgrade-package",[155,384,188],{"class":164},[146,386,388],{"className":148,"code":387,"filename":121,"language":150,"meta":151,"style":151},"mamba update -c conda-forge compas\n",[119,389,390],{"__ignoreMap":151},[155,391,392,394,397,399,401],{"class":157,"line":158},[155,393,121],{"class":161},[155,395,396],{"class":164}," update",[155,398,209],{"class":174},[155,400,212],{"class":164},[155,402,188],{"class":164},[146,404,406],{"className":148,"code":405,"filename":124,"language":150,"meta":151,"style":151},"conda update -c conda-forge compas\n",[119,407,408],{"__ignoreMap":151},[155,409,410,412,414,416,418],{"class":157,"line":158},[155,411,124],{"class":161},[155,413,396],{"class":164},[155,415,209],{"class":174},[155,417,212],{"class":164},[155,419,188],{"class":164},[146,421,423],{"className":148,"code":422,"filename":136,"language":150,"meta":151,"style":151},"pip install --upgrade compas\n",[119,424,425],{"__ignoreMap":151},[155,426,427,429,431,434],{"class":157,"line":158},[155,428,136],{"class":161},[155,430,291],{"class":164},[155,432,433],{"class":174}," --upgrade",[155,435,188],{"class":164},[437,438,439],"tip",{},[64,440,441,442,445,446,449,450,452],{},"Extensions install the same way. Replace ",[119,443,444],{},"compas"," with the package name, for example ",[119,447,448],{},"uv add compas_viewer",". See ",[68,451,20],{"href":22}," for what is available.",[454,455,456],"style",{},"html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}",{"title":151,"searchDepth":171,"depth":171,"links":458},[459,460,461,462],{"id":87,"depth":180,"text":88},{"id":139,"depth":180,"text":140},{"id":296,"depth":180,"text":297},{"id":364,"depth":180,"text":365},"Install COMPAS with uv, mamba, conda or pip.","md","Overview",{},true,"\u002Fdocs\u002Foverview\u002Finstallation",{"title":59,"description":463},"docs\u002F1.overview\u002F2.installation","X0tZp6PQ3eWaNjVIF7cFT6RPqmKg0O-xlspwv50d--E",null,[474,477],{"title":475,"path":18,"stem":476,"children":-1},"Introduction","docs\u002F1.overview\u002F1.introduction",{"title":478,"path":479,"stem":480,"children":-1},"First Steps","\u002Fdocs\u002Foverview\u002Ffirst-steps","docs\u002F1.overview\u002F3.first-steps",[482],{"title":16,"path":483,"stem":484,"children":485,"page":502},"\u002Fdocs","docs",[486,503,533,551],{"title":465,"icon":487,"path":488,"stem":489,"children":490,"page":502},"i-heroicons-play","\u002Fdocs\u002Foverview","docs\u002F1.overview",[491,492,493,494,498],{"title":475,"path":18,"stem":476},{"title":59,"path":468,"stem":470},{"title":478,"path":479,"stem":480},{"title":495,"path":496,"stem":497},"What's Next","\u002Fdocs\u002Foverview\u002Fwhats-next","docs\u002F1.overview\u002F4.whats-next",{"title":499,"path":500,"stem":501},"Ecosystem","\u002Fdocs\u002Foverview\u002Fecosystem","docs\u002F1.overview\u002F5.ecosystem",false,{"title":504,"icon":505,"path":506,"stem":507,"children":508,"page":502},"Features","i-heroicons-sparkles-solid","\u002Fdocs\u002Ffeatures","docs\u002F2.features",[509,513,517,521,525,529],{"title":510,"path":511,"stem":512},"Robust Geometry Kernel","\u002Fdocs\u002Ffeatures\u002Fgeometry","docs\u002F2.features\u002F1.geometry",{"title":514,"path":515,"stem":516},"Flexible Data Models","\u002Fdocs\u002Ffeatures\u002Fdata","docs\u002F2.features\u002F2.data",{"title":518,"path":519,"stem":520},"Interoperability Across Tools","\u002Fdocs\u002Ffeatures\u002Finterop","docs\u002F2.features\u002F3.interop",{"title":522,"path":523,"stem":524},"Cross Platform","\u002Fdocs\u002Ffeatures\u002Fcross-platform","docs\u002F2.features\u002F4.cross-platform",{"title":526,"path":527,"stem":528},"Modular Extension Ecosystem","\u002Fdocs\u002Ffeatures\u002Fextensions","docs\u002F2.features\u002F5.extensions",{"title":530,"path":531,"stem":532},"Developer-Friendly Foundation","\u002Fdocs\u002Ffeatures\u002Fdevelopers","docs\u002F2.features\u002F6.developers",{"title":534,"icon":535,"path":536,"stem":537,"children":538,"page":502},"Examples","i-heroicons-beaker","\u002Fdocs\u002Fexamples","docs\u002F3.examples",[539,543,547],{"title":540,"path":541,"stem":542},"Making a box","\u002Fdocs\u002Fexamples\u002Fbox","docs\u002F3.examples\u002F1.box",{"title":544,"path":545,"stem":546},"Points and vectors","\u002Fdocs\u002Fexamples\u002Fpoints-and-vectors","docs\u002F3.examples\u002F2.points-and-vectors",{"title":548,"path":549,"stem":550},"Planes and frames","\u002Fdocs\u002Fexamples\u002Fplanes-and-frames","docs\u002F3.examples\u002F3.planes-and-frames",{"title":552,"icon":553,"path":554,"stem":555,"children":556,"page":502},"Cite & Credit","i-heroicons-academic-cap","\u002Fdocs\u002Fcite","docs\u002F4.cite",[557],{"title":558,"path":559,"stem":560},"Show it on your project","\u002Fdocs\u002Fcite\u002Fshow-it-on-your-project","docs\u002F4.cite\u002F1.show-it-on-your-project","2.15.1",1791765877555]