crate-sim 1.0.1
CRATE: Clustering-based Nonlinear Analysis of Materials
License: BSD-3-Clause License
Requires Python: >=3.6
Keywords: simulation,clustering,materials,homogenization,modeling



<p align="center">
  <a href=""><img alt="logo" src="https://user-images.githubusercontent.com/25851824/238439999-4170acd2-409e-4e0c-b262-5971a7df418e.png" width="80%"></a>
</p>

# What is CRATE?

[**Docs**](https://bessagroup.github.io/CRATE/)
| [**Installation**](https://bessagroup.github.io/CRATE/rst_doc_files/getting_started/installation.html)
| [**GitHub**](https://github.com/bessagroup/CRATE)
| [**PyPI**](https://pypi.org/project/crate-sim/)

### Summary
**CRATE** (Clustering-based Nonlinear Analysis of Materials) is a Python program developed in the context of computational mechanics to aid the design and development of new materials. Its main purpose is **performing multi-scale nonlinear analyses of heterogeneous materials** through a suitable coupling between first-order computational homogenization and clustering-based reduced-order modeling: given a representative volume element of the material microstructure and the corresponding material phase properties, CRATE computes the material's effective mechanical response when subject to a prescribed macro-scale loading path.

### Authorship & Citation
CRATE was originally developed by Bernardo P. Ferreira<sup>[1](#f1)</sup> in the context of his PhD Thesis<sup>[2](#f2)</sup>.

If you use CRATE in a scientific publication, it is appreciated that you cite this PhD Thesis:

```
@phdthesis{ferreira:2022a,
  title = {Towards Data-driven Multi-scale Optimization of Thermoplastic Blends: Microstructural Generation, Constitutive Development and Clustering-based Reduced-Order Modeling},
  author = {Ferreira, B.P.},
  year = {2022},
  langid = {english},
  school = {University of Porto},
  url={https://hdl.handle.net/10216/146900}
}
```

<sup id="f1"> 1 </sup> Profile: [LinkedIN](https://www.linkedin.com/in/bpferreira/), [ORCID](https://orcid.org/0000-0001-5956-3877), [ResearchGate](https://www.researchgate.net/profile/Bernardo-Ferreira-11?ev=hdr_xprf)

<sup id="f2"> 2 </sup> Ferreira, B.P. (2022). *Towards Data-driven Multi-scale Optimization of Thermoplastic Blends: Microstructural Generation, Constitutive Development and Clustering-based Reduced-Order Modeling.* PhD Thesis, University of Porto (see [here](http://dx.doi.org/10.13140/RG.2.2.33940.17289))

----

# Getting started

You can find everything you need to know in [CRATE documentation](https://bessagroup.github.io/CRATE/)!


<p align="center">
  <a href=""><img alt="logo" src="https://user-images.githubusercontent.com/25851824/238440445-48811f19-8131-4161-8eeb-108197221986.png" width="80%"></a>
</p>


# Community Support

If you find any **issues**, **bugs** or **problems** with CRATE, please use the [GitHub issue tracker](https://github.com/bessagroup/CRATE/issues) to report them. Provide a clear description of the problem, as well as a complete report on the underlying details, so that it can be easily reproduced and (hopefully) fixed!

You are also welcome to post there any **questions**, **comments** or **suggestions** for improvement in the [GitHub discussions](https://github.com/bessagroup/CRATE/discussions) space!

>**Note:**  
>Bear in mind that CRATE is a program developed in an academic environment and that I'm currently the only developer as a side project. This means that I'll do my best to address all the issues, questions and suggestions, but do expect a reasonable time frame! ~ *Bernardo P. Ferreira*


# Credits

* Bernardo P. Ferreira is deeply thankful to [Francisco Pires](https://sigarra.up.pt/feup/pt/func_geral.formview?p_codigo=240385) and [Miguel Bessa](https://github.com/mabessa) for supervising the PhD Thesis that motivated the development of CRATE.


# License

Copyright 2020, Bernardo Ferreira

All rights reserved.

CRATE is a free and open-source software published under a BSD 3-Clause License.