{"id":30729362,"url":"https://github.com/nathanrooy/p-area","last_synced_at":"2025-09-03T15:07:52.888Z","repository":{"id":55618119,"uuid":"319719974","full_name":"nathanrooy/p-area","owner":"nathanrooy","description":"The easiest way to compute the frontal/projected area of an STL geometry file. Useful for aerodynamic/CFD applications.","archived":false,"fork":false,"pushed_at":"2021-06-01T21:12:46.000Z","size":98,"stargazers_count":17,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-31T00:52:39.505Z","etag":null,"topics":["aerodynamics","cfd","computational-fluid-dynamics","frontal-area","projected-area"],"latest_commit_sha":null,"homepage":"","language":"Python","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/nathanrooy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-08T18:02:47.000Z","updated_at":"2025-03-29T07:08:11.000Z","dependencies_parsed_at":"2022-08-15T04:31:40.614Z","dependency_job_id":null,"html_url":"https://github.com/nathanrooy/p-area","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nathanrooy/p-area","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanrooy%2Fp-area","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanrooy%2Fp-area/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanrooy%2Fp-area/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanrooy%2Fp-area/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nathanrooy","download_url":"https://codeload.github.com/nathanrooy/p-area/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathanrooy%2Fp-area/sbom","scorecard":{"id":675844,"data":{"date":"2025-08-11","repo":{"name":"github.com/nathanrooy/p-area","commit":"6a3d29b80415324abd65ee0e0b71c8e0dbdf80f2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":0,"reason":"Found 0/27 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":"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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml:1","Warn: no topLevel permission defined: .github/workflows/pypi.yaml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/nathanrooy/p-area/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/nathanrooy/p-area/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nathanrooy/p-area/pypi.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nathanrooy/p-area/pypi.yaml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:30","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:31","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:32","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:33","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:39","Warn: downloadThenRun not pinned by hash: .github/workflows/ci.yaml:41","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:23","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:24","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:25","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:26","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned"],"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":"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":"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"}},{"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE: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 'main'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T21:25:57.594Z","repository_id":55618119,"created_at":"2025-08-21T21:25:57.594Z","updated_at":"2025-08-21T21:25:57.594Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273460843,"owners_count":25109816,"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-03T02:00:09.631Z","response_time":76,"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":["aerodynamics","cfd","computational-fluid-dynamics","frontal-area","projected-area"],"created_at":"2025-09-03T15:07:48.275Z","updated_at":"2025-09-03T15:07:52.873Z","avatar_url":"https://github.com/nathanrooy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/nathanrooy/p-area/main/logo/logo.png\" width=\"50%\"\u003e\u003c/p\u003e\n\n[![gh-actions-ci](https://img.shields.io/github/workflow/status/nathanrooy/p-area/ci?style=flat-square)](https://github.com/nathanrooy/p-area/actions?query=workflow%3Aci)\n[![GitHub license](https://img.shields.io/github/license/nathanrooy/p-area?style=flat-square)](https://github.com/nathanrooy/p-area/blob/master/LICENSE)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/parea.svg?style=flat-square)](https://pypi.org/pypi/parea/)\n[![PyPi Version](https://img.shields.io/pypi/v/parea.svg?style=flat-square)](https://pypi.org/project/parea)\n[![codecov](https://img.shields.io/codecov/c/github/nathanrooy/p-area.svg?style=flat-square)](https://codecov.io/gh/nathanrooy/p-area)\n\nMost \u003ca target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Lift_coefficient\"\u003elift\u003c/a\u003e and \u003ca target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Drag_coefficient\"\u003edrag\u003c/a\u003e calculations require the use of a frontal/projected area. This is normally not that big of a deal, especially when dealing with nice clean CAD files. Unfortunately, in fast-paced design environments (motorsport especially), you'll often get a collection of \u003ca target=\"_blank\" href=\"https://en.wikipedia.org/wiki/STL_(file_format)\"\u003eSTL\u003c/a\u003e geometry files instead. This is annoying for a number of reasons, but mainly because there are several methods for computing the frontal area of an STL and all of them involve a fairly tedious/lengthy process. pArea aims to solve this with a single command. [[original blog post](https://nathanrooy.github.io/posts/2021-03-26/compute-stl-frontal-area/)]\n\n\n### Installation\n```\npip install parea\n```\n\n### Usage\nAs a simple example, the \u003ca target=\"_blank\" href=\"https://github.com/nathanrooy/p-area/blob/main/tests/data/cube_ascii.stl\"\u003ecube\u003c/a\u003e STL located within the `tests` directory has a projected area of 4.0 along all three coordinate axes. To validate this, simply run the following (assuming you've downloaded cube_ascii.stl into your current working directory):\n\n```\nparea -stl cube_ascii.stl -x\n```\n\nFor models comprised of multiple STL files, simply separate the file names with a space:\n\n```\nparea -stl file_1.stl file_2.stl file_3.stl -x\n```\n\nOr use shell-style wildcards:\n\n```\nparea -stl file_*.stl  -x\n```\n\nWhen simulating ground vehicles with non-rigid wheels, you will need to account for the tire deformation and subsequent ride height drop. This can be accounted for by using the `-floor` flag followed by a floor height value. Note that floor height is in reference to the vertical axis of the specified projection plane and maintains the same units as the STL file. As an example:\n\n```\nparea -stl file_*.stl  -x -floor 0.0125\n```\nSince the projection vector is `x`, our projection plane is therefore `yz` yielding a projected area based off all geometry \u003cb\u003eabove\u003c/b\u003e z \u003e= 0.0125. All geometry below the horizontal line z=0.0125 is accordingly trimmed (if necessary) and removed from the calculation.\n\n### Options\nvectors: `-x`, `-y`, `-z`\n\nplanes: `-yz`/`-zy`, `-xz`/`-zx`, `-xy`/`-yx`\n\n### References\n- Computational Geometry: Algorithms and Applications (3rd Edition) by Mike de Borg, Otfried Cheong, Mark van Kreveld, and Mark Overmars\n- Computational Geometry in C (2nd Edition) by Joseph O'Rourke\n- Finite Element Mesh Generation by Daniel S.H. Lo\n- Command Line Interface Guidelines [\u003ca href=\"https://github.com/cli-guidelines/cli-guidelines\"\u003elink\u003c/a\u003e]\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathanrooy%2Fp-area","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnathanrooy%2Fp-area","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathanrooy%2Fp-area/lists"}