Brep-part-finder is able to search within a Brep file for parts that match user specified properties such as volume, center of mass and bounding box. The matching ID number of the part will be returned if found.
This is useful because the order or parts changes when exporting to Brep files. This part finder package helps keep track of meta data within a workflow. The neutronics workflow makes use of this package to help correctly identify materials when making DAGMC h5m files from Paramak geometries for neutronics simulations.
Installation (Conda)
The installation instructions below create a new conda enviroment and install
conda create --name bpf_env
conda activate bpf_env
conda install -c cadquery -c fusion-energy -c conda-forge brep_part_finder
Installation (Conda + Pip)
The installation instructions below create a new conda enviroment, install CadQuery and install this package. The master branch of CadQuery is currently required as latest features are required. When CadQuery version 2.2 is released then install can target a stable version.
conda create --name bpf_env
conda activate bpf_env
conda install -c cadquery -c conda-forge cadquery=master
pip install brep_part_finder
Usage
To view the properties of the parts in the Brep file the first stage is to import the package and make use of the get_brep_part_properties function.
import brep_part_finder as bpf
my_brep_part_properties = bpf.get_brep_part_properties('my_brep_file.brep')
print(my_brep_part_properties)
>>>{
1: {
'Center.x': 0, 'Center.y': 0, 'Center.z': 0,
'Volume': 10,
'BoundingBox.xmin': -20, 'BoundingBox.ymin': -20, 'BoundingBox.zmin': -20,
'BoundingBox.xmax': 20, 'BoundingBox.ymax': 20, 'BoundingBox.zmax': 20
},
2: {
'Center.x': 5, 'Center.y': 6, 'Center.z': 7,
'Volume': 10,
'BoundingBox.xmin': -40.0, 'BoundingBox.ymin': -40.0, 'BoundingBox.zmin': -40.0,
'BoundingBox.xmax': 40.0, 'BoundingBox.ymax': 40.0, 'BoundingBox.zmax': 40.0
},
3: {
'Center.x': 0, 'Center.y': 0, 'Center.z': 0,
'Volume': 10,
'BoundingBox.xmin': -10, 'BoundingBox.ymin': -10, 'BoundingBox.zmin': -10,
'BoundingBox.xmax': 10, 'BoundingBox.ymax': 10, 'BoundingBox.zmax': 10
}
}
From the above dictionary it is possible to identify parts from their central of mass (x,y,z coordinate), volume and bounding box. This can be done manually or one can pass the required properties into the find_part_id or find_part_ids functions to identify the part numbers of solids automatically.
A minimal example that finds the part id numbers with matching volumes
import brep_part_finder as bpf
my_brep_part_properties = bpf.get_brep_part_properties('my_brep_file.brep')
part_id = bpf.find_part_id(
brep_part_properties=my_brep_part_properties,
volume=10,
)
print(part_id)
>> [1, 3, 4]
The above example found 3 part ids with matching volumes.
The follow example also specifies the center of mass which helps narrow down the part ids to just to matching parts.
import brep_part_finder as bpf
my_brep_part_properties = bpf.get_brep_part_properties('my_brep_file.brep')
part_id = bpf.find_part_id(
brep_part_properties=my_brep_part_properties,
volume=10,
center_of_mass=(0,0,0),
)
print(part_id)
>> [1, 3]
In the this example the bounding box of the part has also been specified and these three pieces of information are enough to find one part that matches all three criteria.
import brep_part_finder as bpf
my_brep_part_properties = bpf.get_brep_part_properties('my_brep_file.brep')
part_id = bpf.find_part_id(
brep_part_properties=my_brep_part_properties,
volume=10,
center_of_mass=(0,0,0),
bounding_box = [[10,10,10], [-10,-10,10]]
)
print(part_id)
>> [3]
For more usage examples see the examples folder in this repository
Combining with Paramak
When reactor models made with Paramak are exported to Brep files it is likely that the order of parts in the Brep file does not match the order of parts within the Paramak object. Therefore this program is useful when identifying parts in the Brep file. See the paramak_example file in the examples folder of this repository.
Metadata
Release files for brep-part-finder 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| brep_part_finder-0.5.2.tar.gz | 80.1 kB | Without provenance | Details for brep_part_finder-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| brep_part_finder-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for brep_part_finder-0.5.2-py3-none-any.whl |
Total release size: 88.2 kB
Release files / brep_part_finder-0.5.2.tar.gz
| Download URL | brep_part_finder-0.5.2.tar.gz |
|---|---|
| Size | 80.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b42e9efb066727eb8deac485ee7f258e0760c893ff53db41bab3ab4baf4198d5
|
|
BLAKE2b-256 checksum How to use checksums |
f246f8001047e1da149af51a1bf144fcaa89257d128134e32e7077940df806f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.0
|
Release files / brep_part_finder-0.5.2-py3-none-any.whl
| Download URL | brep_part_finder-0.5.2-py3-none-any.whl |
|---|---|
| Size | 8.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
314a18f634487c8e507188342a5d943bf67ddb492eab57af6eb80ce9e54e773f
|
|
BLAKE2b-256 checksum How to use checksums |
30fef773a5a7d41698f1b5bbd1622b658ee2c171ae08c85ba3458ed384d8f64e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.0
|
Security for brep-part-finder 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.