{"id":30895511,"url":"https://github.com/ladybug-tools/spider-gbxml-tools","last_synced_at":"2025-09-08T22:07:00.847Z","repository":{"id":57245316,"uuid":"140885671","full_name":"ladybug-tools/spider-gbxml-tools","owner":"ladybug-tools","description":"Scripts to help you view and manage gbXML files","archived":false,"fork":false,"pushed_at":"2021-09-21T16:05:23.000Z","size":16100,"stargazers_count":16,"open_issues_count":8,"forks_count":4,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-23T02:45:45.701Z","etag":null,"topics":["file-viewer","gbxml","ladybug-tools","openstudio"],"latest_commit_sha":null,"homepage":"https://www.ladybug.tools/spider-gbxml-tools/","language":"JavaScript","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/ladybug-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-13T19:29:15.000Z","updated_at":"2025-03-22T16:01:37.000Z","dependencies_parsed_at":"2022-09-01T06:11:01.460Z","dependency_job_id":null,"html_url":"https://github.com/ladybug-tools/spider-gbxml-tools","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/ladybug-tools/spider-gbxml-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fspider-gbxml-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fspider-gbxml-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fspider-gbxml-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fspider-gbxml-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybug-tools","download_url":"https://codeload.github.com/ladybug-tools/spider-gbxml-tools/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fspider-gbxml-tools/sbom","scorecard":{"id":576906,"data":{"date":"2025-08-11","repo":{"name":"github.com/ladybug-tools/spider-gbxml-tools","commit":"7ade1e3bbdfa50f07ee35520d8d11e1bbc4e3757"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}}]},"last_synced_at":"2025-08-20T18:05:49.114Z","repository_id":57245316,"created_at":"2025-08-20T18:05:49.114Z","updated_at":"2025-08-20T18:05:49.114Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274231549,"owners_count":25245659,"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-09-08T02:00:09.813Z","response_time":121,"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":["file-viewer","gbxml","ladybug-tools","openstudio"],"created_at":"2025-09-08T22:06:58.752Z","updated_at":"2025-09-08T22:07:00.830Z","avatar_url":"https://github.com/ladybug-tools.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cspan style=display:none; \u003e[You are now in a GitHub source code view - click this link to view Read Me file as a web page](https://www.ladybug.tools/spider-gbxml-tools/index.html#README.md \"View file as a web page.\" ) \u003c/span\u003e\n\n\n\u003cdiv\u003e\u003cinput type=button class = btn btn-secondary btn-sm\" onclick=window.location.href=\"https://github.com/ladybug-tools/spider-gbxml-tools/\" value=\"You are now in a GitHub web page view - Click this button to view this read me file as source code\" \u003e\u003cdiv\u003e\n\n\u003cbr\u003e\n\n# [Spider gbXML Tools Read Me]( #README.md )\n\n\u003ciframe class=iframeReadMe src=https://www.ladybug.tools/spider-gbxml-tools/cookbook/spider-gbxml-iframe-carousel/ width=100% height=500px \u003eIframes are not displayed on github.com\u003c/iframe\u003e\n_\u003csmall\u003eSpider gbXML Viewer ~ [Iframe Carousel]( https://www.ladybug.tools/spider-gbxml-tools/index.html#cookbook/spider-gbxml-iframe-carousel/README.md ): display multiple interactive 3D models in a single space on any web page. Scroll zoom in display turned off so read me can scroll.\u003c/small\u003e_\n\n\n### Welcome \u003ca href=\"http://gbxml.org/\" title=\"Hi Stephen!\" target=\"_blank\"\u003egbXML\u003c/a\u003e users!\n\n### Welcome \u003ca href=\"https://www.openstudio.net/\" title=\"Hi Dan! Hi NREL!\" target=\"_blank\"\u003eOpen Studio\u003c/a\u003e fans!\n\n### Welcome [LinkedIn]( https://www.linkedin.com/feed/update/urn:li:activity:6458956499195568128/ ) and [discourse.ladybug.tools]( https://discourse.ladybug.tools/t/spider-gbxml-viewer-embedded-in-openstudio/4129 ) viewers\n\n\u003chr\u003e\n\n\u003c!--\n\n## Welcome \u003ca href=\"https://www.rtcevents.com/bilt/eur18/\" title=\"Hi Michal! Hi Ljubljana!\" style=color:red; target=\"_blank\"\u003eBILT EUR 2018\u003c/a\u003e attendees!\n--\u003e\n\n## Stable version:  [Spider gbXML Viewer 'Maevia' ]( https://www.ladybug.tools/spider-gbxml-tools/spider-gbxml-viewer/ \"this one is hot\" )\n\n## Development version:  [Spider gbXML Viewer Dev ]( https://www.ladybug.tools/spider-gbxml-tools/spider-gbxml-viewer/dev/ )\n\n\n### Pre-release fixer: [Spider gbXML Fixer 'Atrax' ]( https://www.ladybug.tools/spider-gbxml-fixer/ \"this one is cool\" )\n\n\u003c!--\n### Latest pre-release popup: [Spider gbXML Viewer Popup ]( https://www.ladybug.tools/spider-gbxml-tools/spider-gbxml-viewer/pop/ \"this one is small\" )\n\n--\u003e\n\n\u003cbr\u003e\n\n[Spider gbXML Tools]( https://github.com/ladybug-tools/spider \"Source code on GitHub\" ) is a collection of [free, open source]( https://opensource.guide/ \"Read all about it at OpenSource Guides\" ) modular [JavaScript]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/About_JavaScript \"Callout to Brendan\" ) / [WebGL]( https://www.khronos.org/webgl/ \"Tip of the hat to Ken Russell\" ) / [Three.js]( https://threejs.org/ \"Hi Mr.doob\" ) experiments hosted on [GitHub]( https://github.com/about \"Beep for where the geek peeps keep\" ) for viewing, validating and editing [gbXML]( http://gbxml.org \"Where's your schema today?\" ) files in 3D in your browser. gbXML is an industry supported file format for sharing building information between numerous building design software tools.\n\nThe scripts here started as a fork of the scripts at https://www.ladybug.tools/spider/. The scripts there are in the process of becoming long-term support only scripts. All significant current gbXML viewer development is occurring in this repository.\n\n\nThe intention is to provide a faster, simpler more effective user experience base on a simpler, more modular code base.\n\nThe impetus for this code arose from the request by the developers of OpenStudio for a viewer that can be embedded in their code. It became quickly evident that the new codebase offered significant advantages over the the previous codebase. And, thus, the majority of ongoing development efforts have been transferred to this project. Previous releases will be supported at least to the extent of fixing bugs that that are reported.\n\n\n\n\u003cbr\u003e\n\n\u003cdetails\u003e\n\n\u003csummary style=font-size:1.5rem; \u003eConcept / the desired pattern\u003c/summary\u003e\n\n_Mission: knowledge embedded in gbXML files is viewable, analyzable and editable in real-time interactive 3D with free, open-source web apps_\n\n\nMore detailed background in the ['Maevia' Read Me]( https://www.ladybug.tools/spider-gbxml-tools/index.html#spider-gbxml-viewer/README.md )\n\n\n### The current issues / the problems to be solved\n\n\n[Green Building XML (gbXML)]( https://en.wikipedia.org/wiki/Green_Building_XML ) as described by its authors:\n\n\u003e gbXML allows disparate 3D [building information models (BIM)]( https://en.wikipedia.org/wiki/Building_information_modeling ) and architectural/engineering analysis software to share information with each other\n\nThe current set of [BIM authoring and CAD software tools]( http://www.gbxml.org/Software_Tools_that_Support_GreenBuildingXML_gbXML ) for gbXML include various proprietary, closed-source applications that you must download and install.\n\nGbXML being open source, it would also be nice to be able to view gbXML files in 3D in your browser with no fees and with open source code.\n\nThe Ladybug Tools/Spider gbXML Viewer scripts are first steps toward making gbXML viewers readily available.\n\n### Mission\n\ngbXML Viewer is a collection of modular experiments for viewing, examining and validating gbXML files in 3D in your browser.\n\n#### General objectives\n\n* Open and display files almost instantly\n* Non-modal interface\n* Fast effective workflow: get things done faster\n* Fully interactive 3D\n\n\n#### Vision and engineering objectives\n\n* Helping students, clients and non-AEC peeps gain access BIM data easily, quickly and freely\n* Facilitating the transfer of data between design programs and analysis programs\n\n#### Coding objectives\n\n* Files are no more than a few hundred lines\n* Code is simple, plain-vanilla JavaScript\n* Every JavaScript file has its own name space so you can quickly identify the location of variables and functions\n* Every module has a descriptive read me file\n* Every JavaScript file has an accompanying standalone HTML file for testing purposes\n* All revisions are always available and runnable via GitHub pages with a click of a button\n\n#### Previous releases always available to run and view in your browser\n\n* [Spider gbXML Viewer Previous Releases]( https://www.ladybug.tools/spider/index.html#gbxml-viewer/previous-releases.md )\n\t* Load and run every release of the gbXML Viewer since the first commit\n\t* Watch the development process of a project unfold\n\n\n\u003c/details\u003e\n\n\n\n\n\u003cdetails\u003e\n\n\u003csummary style=font-size:1.5rem; title=\"Better title for this section?\" \u003eLinks of interest\u003c/summary\u003e\n\n\n#### gbXML Home Page\n\n* \u003chttp://www.gbxml.org/\u003e\n\n\u003e gbXML is an industry supported schema for sharing building information between disparate building design software tools.\n\n\n#### gbXML GitHub Presence\n* \u003chttps://github.com/GreenBuildingXML\u003e\n\t* \u003chttps://github.com/GreenBuildingXML/gbXML-Schema\u003e\n\t* \u003chttps://github.com/GreenBuildingXML/Sample-gbXML-Files\u003e\n\t* [Spider gbXML Viewer fork]( https://github.com/GreenBuildingXML/spider )\n\n\u003e Repositories for all things gbXML including the schema, validator source code, test cases, and a fork of the Spider gbXML Viewer\n\n\n#### gbXML Schema as a document\n\n* \u003chttp://gbxml.org/schema_doc/6.01/GreenBuildingXML_Ver6.01.html\u003e\n\n\u003e Schema GreenBuildingXML_Ver6.01.xsd / the core definition of gbXML in a format that is easier to read than the source code.\n\n\n### More gbXML References\n\n* \u003chttps://en.wikipedia.org/wiki/Green_Building_XML\u003e\n\n\u003e The Green Building XML schema (gbXML) is an open schema developed to facilitate transfer of building data stored in Building Information Models (BIM) to engineering analysis tools. gbXML is being integrated into a range of software CAD and engineering tools and supported by leading 3D BIM vendors. gbXML is streamlined to transfer building properties to and from engineering analysis tools to reduce the interoperability issues and eliminate plan take-off time.\n\n\n* \u003chttps://twitter.com/gbXML\u003e\n* The gbXML open schema helps facilitate the transfer of building properties stored in 3D building information models (BIM) to engineering analysis tools.\n\n\n### DOE / NREL / OpenStudio\n\n* [US Department of Energy]( https://www.energy.gov/ )\n* [National Renewable Energy Laboratory]( https://www.nrel.gov/ )\n\t* The National Renewable Energy Laboratory is a national laboratory of the U.S. Department of Energy, Office of Energy Efficiency and Renewable Energy, operated by the Alliance for Sustainable Energy, LLC.\n\t* https://github.com/NREL\n* [OpenStudio]( https://www.openstudio.net/ )\n\t* OpenStudio is a cross-platform collection of software tools to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance.\n\t* https://github.com/NREL/OpenStudio\n\n#### OpenStudio User Docs / Advanced Tutorials / Working with gbXML\n\n* [OpenStudio User Documentation]( https://nrel.github.io/OpenStudio-user-documentation/ )\n\n* [Working with gbXML]( https://nrel.github.io/OpenStudio-user-documentation/tutorials/tutorial_gbxmlimport/ )\n\n\u003e gbXML is an industry supported file format for sharing building information between disparate building design software tools. The OpenStudio Application can import and export gbXML files through the File-\u003eImport and File-\u003eExport menus.\n\nNREL include a very basic version of the Spider gbXML Viewer in current releases of OpenStudio. The Ladybug Tools / Spider team is proud to be included in the project and makes best efforts to support users.\n\n\u003cimg src=\"https://www.ladybug.tools/spider-gbxml-tools/images/openstudio-imported-gbxml.jpg\" width=800 \u003e\n\n_Screen capture NREL tutorial on Spider gbXML Viewer running in OpenStudio_\n\n### Other Spider gbXML Resources\n\n#### [Spider gbXML Sample Files]( https://www.ladybug.tools/spider/index.html#gbxml-sample-files/README.md)\n\nAccess to gbXML files from a variety of sources either available by URL or availble to download or both\n\n#### [Spider gbXML User Guide]( https://www.ladybug.tools/spider/gbxml-user-guide/gbxml-user-guide.html )\n\nA work-in-progress\n\n\n#### [Spider Build Well]( https://www.ladybug.tools/spider/index.html#build-well/README.md )\n\nCreate 3D building data in a variety of shapes parametrically and export in gbXML format\n\n\n#### [Spider gbXML to OpenStudio Report]( https://www.ladybug.tools/spider-gbxml-tools/#gbxml-to-openstudio-report.md )\n\n\nThe goal of the scripts in this project is to enable you to transfer data from a CAD progran to an analysis program with as few steps of human intervention as possible.\n\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\n\u003csummary style=font-size:1.5rem; \u003eTo do / Change log\u003c/summary\u003e\n\n## To Do\n\nEvery module has its own read me file with its own to do list\n\nThis list is for items that relates to the overall content management including the TooToo scripts\n\n## Change log\n\n### 2019-08-03 ~ Theo\n\nNew home page based on tootoo cms v0.14.06\n\n### 2019-01-01 ~ Theo\n\nNew home page based on tootoo cms r13\n\n\u003c/details\u003e\n\n***\n\n# \u003ccenter title=\"hello!\" \u003e\u003ca href=javascript:window.scrollTo(0,0); style=text-decoration:none; \u003e \u003cimg src='https://ladybug.tools/artwork/icons_bugs/ico/spider.ico' height=24 \u003e \u003c/a\u003e\u003c/center\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fspider-gbxml-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybug-tools%2Fspider-gbxml-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fspider-gbxml-tools/lists"}