Skip to content

Commit

Permalink
Adding a citation
Browse files Browse the repository at this point in the history
  • Loading branch information
gumyr committed Feb 14, 2025
1 parent 36e7958 commit bcda478
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
cff-version: 1.2.0
message: "If you use build123d in your research, please cite it using the following information."
title: "build123d: A Python-based parametric CAD library"
version: "0.9.1"
doi: "10.5281/zenodo.14872323"
authors:
- name: "Roger Maitland"
affiliation: "Independent Developer"
date-released: "2024-02-14"
repository-code: "https://github.com/gumyr/build123d"
license: "Apache-2.0"
keywords:
- CAD
- Python
- OpenCascade
- Parametric Design
19 changes: 19 additions & 0 deletions Citation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Citation

If you use **build123d** in your research, please cite:

Roger Maitland. **"build123d: A Python-based parametric CAD library"**. Version 0.9.1, 2025.
DOI: [10.5281/zenodo.14872323](https://doi.org/10.5281/zenodo.14872323)
Source Code: [GitHub](https://github.com/gumyr/build123d)

## BibTeX Entry

```bibtex
@software{build123d,
author = {Roger Maitland},
title = {build123d: A Python-based parametric CAD library},
year = {2025},
version = {0.9.1},
doi = {10.5281/zenodo.14872323},
url = {https://github.com/gumyr/build123d}
}
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
[![Downloads](https://pepy.tech/badge/build123d)](https://pepy.tech/project/build123d)
[![Downloads/month](https://pepy.tech/badge/build123d/month)](https://pepy.tech/project/build123d)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/build123d.svg)](https://pypi.org/project/build123d/)
[![DOI](https://zenodo.org/badge/510925389.svg)](https://doi.org/10.5281/zenodo.14872322)


Build123d is a python-based, parametric, [boundary representation (BREP)][BREP] modeling framework for 2D and 3D CAD. It's built on the [Open Cascade] geometric kernel and allows for the creation of complex models using a simple and intuitive python syntax. Build123d can be used to create models for 3D printing, CNC machining, laser cutting, and other manufacturing processes. Models can be exported to a wide variety of popular CAD tools such as [FreeCAD] and SolidWorks.

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ dependencies = [
"Homepage" = "https://github.com/gumyr/build123d"
"Documentation" = "https://build123d.readthedocs.io/en/latest/index.html"
"Bug Tracker" = "https://github.com/gumyr/build123d/issues"
"Citation" = "https://doi.org/10.5281/zenodo.14872323"

[project.optional-dependencies]
# enable the optional ocp_vscode visualization package
Expand Down

0 comments on commit bcda478

Please sign in to comment.