Metadata-Version: 2.1
Name: engineeringdoe
Version: 0.1.0
Summary: A package for Design of Experiments (DoE) and Design Space Exploration (DSE)
Author-email: Alex Pradas <alejandro.pradas@chalmers.se>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: pyDOE2 == 1.3

# EngineeringDoE

## Introduction
This package is a wrapper of pyDOE2 package. It is used to generate design of experiments (DoE) for engineering applications in a way that are easy to set up and export as csv files.

## Installation
To install the package, run the following command in the terminal:
```
pip install EngineeringDoE
```

## Usage
There package support two phases: Generation of DoE and tracking of the evaluation of the DoE design cases.

### Generation of DoE
```python
from EngineeringDoE import DoE, VariableDefinition, Variable

v1 = VariableDefinition("Thickness", bounds=(0.1, 0.5), units="m")
v2 = VariableDefinition("Width", type="discrete", options=[4, 5, 6])
v3 = VariableDefinition("Height", bounds=(0.1, 0.5), units="m") PerformanceMetricDefinition("Weight", "kg")

# create a DoE object with 10 samples distrubuted according to a Latin Hypercube Sampling.
doe = DoE(variables=[v1, v2, v3], n=10)

# export the DoE to a csv file
doe.export("doe.csv")
```

