Metadata-Version: 2.1
Name: volmdlr
Version: 0.14.1
Summary: A volume modeler computation-oriented. Include rendering bindings.
Home-page: https://github.com/Dessia-tech/volmdlr
Author: DessiA Technologies
Author-email: root@dessia.tech
License: Creative Commons Attribution-Share Alike license
Keywords: volume,modeler,CAD
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: packaging
Requires-Dist: dessia-common >=0.10.0
Requires-Dist: Cython >=3.0.0
Requires-Dist: numpy <1.26.0
Requires-Dist: matplotlib
Requires-Dist: scipy <=1.11.1
Requires-Dist: geomdl
Requires-Dist: networkx
Requires-Dist: triangle
Requires-Dist: plot-data >=0.10.9
Requires-Dist: kaitaistruct
Requires-Dist: binaryornot
Requires-Dist: sympy
Requires-Dist: trimesh
Requires-Dist: rtree
Requires-Dist: gmsh
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: nbsphinx ; extra == 'doc'
Requires-Dist: pydata-sphinx-theme ; extra == 'doc'
Requires-Dist: nbformat ; extra == 'doc'
Requires-Dist: nbconvert ; extra == 'doc'
Requires-Dist: sphinx-copybutton ; extra == 'doc'
Requires-Dist: sphinx-design ; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'

<h1 align="center">
  <img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/volmdlr/assets/logos/volmdlr.jpg" style="width:300px"><br/>Volmdlr
</h1>

<h4 align="center">
  A computations-oriented python VOLume MoDeLeR with STEP support for import and export
</h4>

<div align="center">
  <a href="http://dessia.tech/"><img src="https://img.shields.io/website-up-down-green-red/http/dessia.tech.svg"></a>  
  <a href="https://GitHub.com/Dessia-tech/volmdlr/stargazers/"><img src="https://badgen.net/github/stars/Dessia-tech/volmdlr"></a>  
  <a href="https://drone-opensource.dessia.tech/Dessia-tech/volmdlr"><img src="https://drone-opensource.dessia.tech/api/badges/Dessia-tech/volmdlr/status.svg?branch=master"></a>
  <a href="https://pypi.org/project/volmdlr/"><img src="https://img.shields.io/pypi/v/volmdlr.svg"></a>
  <a href="https://github.com/Dessia-tech/volmdlr/graphs/contributors"><img src="https://img.shields.io/github/contributors/Dessia-tech/volmdlr.svg"></a>
  <a href="https://github.com/Dessia-tech/volmdlr/issues"><img src="https://img.shields.io/github/issues/Dessia-tech/volmdlr.svg"></a>
</div>

<div align="center">
  <a href="#description"><b>Description</b></a> |
  <a href="#features"><b>Features</b></a> |
  <a href="#user-installation"><b>User Installation</b></a> |
  <a href="#dev-installation"><b>Dev Installation</b></a> |
  <a href="https://github.com/Dessia-tech/volmdlr/tree/master/scripts"><b>Usage</b></a> |
  <a href="https://documentation.dessia.tech/volmdlr/"><b>Documentation</b></a> |
  <a href="#licence"><b>Licence</b></a> |
  <a href="#contributors"><b>Contributors</b></a> |
</div>

## Description

Volmdlr is a python volume modeler used as a CAD platform.
With it, you can easily create 3D models from python code.
Check the examples to see what you can do with this library.

<p align="center"><img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/casing.jpg" width="40%" /> <img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/casing_contours.png" width="55%" /></p>
<i>A casing is defined by a 2D contour formed with the primitive RoundedLineSegment2D. This contour is offset by the casing width.</i><br/><br/><br/>

<p align="center"><img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/sweep1.jpg" width="45%" /> <img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/sweepMPLPlot.jpg" width="50%" /></p>
<i>A Sweep is pipes, created with Circle2D/Arc2D which is contained in a Contour2D. You have to create the neutral fiber, i.e., the pipeâ€™s road, with the primitive RoundedLineSegment3D.</i><br/><br/><br/>

<p align="center"><img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/polygon.jpg" width="47%" /></p>
<i>A polygon is defined out of points. Random points are sampled and the tested whether they are inside or outside the polygon. They are plotted with the Matplotlib binding MPLPlot with custom styles:
- red if they are outside,
- blue if they are inside
</i><br/><br/><br/>

<p align="center"><img src="https://raw.githubusercontent.com/Dessia-tech/volmdlr/master/doc/source/images/bspline_surface_split.png" width="47%" /></p>
<i>A 3D B-spline surface split by a 3D B-spline curve.</i><br/><br/><br/>

## Features

- [x] Generate 2D and 3D geometries from python
- [x] Handles complexe geometries : B-spline curves and surfaces
- [x] Primitives provide computational tasks : distances, belonging, union, intersections, etc.
- [x] STEP/STL imports and exports
- [x] Geometries display in your web browser with [babylon.js](https://www.babylonjs.com/)

## User Installation

```bash
pip install volmdlr
# or
pip3 install volmdlr
```

## Dev Installation

Before using Volmdlr, be sure to have a C/C++ compiler (not necessary on Linux).  
N.B : With Windows you have to download one and allow it to read Pythonâ€™s code.

First, [clone](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories) the package.
Then, enter the newly created volmdlr repository.
Finally, develop the setup.py file, and you are good to go !

```bash
git clone https://github.com/Dessia-tech/volmdlr.git

cd volmdlr

python3 setup.py develop --user
# or whatever version you are using :
python3.x setup.py develop --user
```

## Usage

See the [script](https://github.com/Dessia-tech/volmdlr/tree/master/scripts) folder for examples

## Documentation

https://documentation.dessia.tech/volmdlr/

## License

100% opensource on LGPL license. See LICENSE for more details.

## Team and contributors

The project leader is [Wirajan Da Silva](https://github.com/WirajanDASILVA).
Volmdlr is mainly developed by the [dessia](https://dessia.tech) company as a part of its opensource SDK, but contributions are welcomed. See [CONTRIBUTING.md](/blob/master/CONTRIBUTING.md) for details

- [DessiA team](https://github.com/orgs/Dessia-tech/people)
- [luzpaz](https://github.com/luzpaz)
