Skip to content

Commit

Permalink
Fix markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
relf committed Apr 11, 2024
1 parent 9f8354b commit ee9dfed
Showing 1 changed file with 20 additions and 25 deletions.
45 changes: 20 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,33 @@
pyDOE3: An experimental design package for python
=================================================

[![Tests](https://github.com/relf/pyDOE3/actions/workflows/tests.yml/badge.svg)](https://github.com/relf/pyDOE3/actions/workflows/tests.yml)
[![Documentation](https://readthedocs.org/projects/pydoe3/badge/?version=latest)](https://pydoe3.readthedocs.io/en/latest/?badge=latest)


pyDOE3: An experimental design package for python
=====================================================

`pyDOE3` is a fork of the [`pyDOE2`](https://github.com/clicumu/pyDOE2) package
that is designed to help the scientist, engineer, statistician, etc., to
`pyDOE3` is a fork of the [`pyDOE2`](https://github.com/clicumu/pyDOE2) package
that is designed to help the scientist, engineer, statistician, etc., to
construct appropriate experimental designs.

This fork came to life to solve bugs and issues that remained unsolved in the
original package.


Capabilities
------------

The package currently includes functions for creating designs for any
The package currently includes functions for creating designs for any
number of factors:

- Factorial Designs
- General Full-Factorial (``fullfact``)
- 2-level Full-Factorial (``ff2n``)
- 2-level Fractional Factorial (``fracfact``)
- Plackett-Burman (``pbdesign``)
- Generalized Subset Designs (``gsd``)
- Response-Surface Designs
- Box-Behnken (``bbdesign``)
- Central-Composite (``ccdesign``)
- General Full-Factorial (``fullfact``)
- 2-level Full-Factorial (``ff2n``)
- 2-level Fractional Factorial (``fracfact``)
- Plackett-Burman (``pbdesign``)
- Generalized Subset Designs (``gsd``)
- Response-Surface Designs
- Box-Behnken (``bbdesign``)
- Central-Composite (``ccdesign``)
- Randomized Designs
- Latin-Hypercube (``lhs``)
- Latin-Hypercube (``lhs``)

See [Documentation](https://pydoe3.readthedocs.io).

Expand All @@ -39,21 +37,19 @@ Requirements
- NumPy
- SciPy


Installation
------------

```
```bash
pip install pyDOE3
```


Credits
-------

`pyDOE` original code was originally converted from code by the following
`pyDOE` original code was originally converted from code by the following
individuals for use with Scilab:

- Copyright (C) 2012 - 2013 - Michael Baudin
- Copyright (C) 2012 - Maria Christopoulou
- Copyright (C) 2010 - 2011 - INRIA - Michael Baudin
Expand All @@ -66,11 +62,10 @@ individuals for use with Scilab:

- Copyright (c) 2014, Abraham D. Lee & timsimst

The following individuals forked and work on `pyDOE2`:
The following individuals forked and worked on `pyDOE2`:

- Copyright (C) 2018 - Rickard Sjögren and Daniel Svensson


License
-------

Expand All @@ -87,4 +82,4 @@ References
- Surowiec, Izabella, Ludvig Vikström, Gustaf Hector, Erik Johansson,
Conny Vikström, and Johan Trygg. “Generalized Subset Designs in Analytical
Chemistry.” Analytical Chemistry 89, no. 12 (June 20, 2017): 6491–97.
https://doi.org/10.1021/acs.analchem.7b00506.
<https://doi.org/10.1021/acs.analchem.7b00506>.

0 comments on commit ee9dfed

Please sign in to comment.