vofotensors 1.0.7
V(ariety)O(f)F(iber)O(rientation)TENSORS contains selected contributions of Bauer JK, Böhlke T. Variety of fiber orientation tensors. Mathematics and Mechanics of Solids. 2022. doi:10.1177/10812865211057602

[![PyPI version](https://badge.fury.io/py/vofotensors.svg)][url_pypi_this_package]
[![Documentation status](https://readthedocs.org/projects/vofotensors/badge/?version=latest)][url_read_the_docs_latest]
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![DOI](https://zenodo.org/badge/356695831.svg)](https://zenodo.org/badge/latestdoi/356695831)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/JulianKarlBauer/vofotensors/HEAD)

<p align="center">
  <a href="https://github.com/JulianKarlBauer/vofotensors">
  <img alt="VoFoTensors" src="logo/logo.png" width="35%">
  </a>
</p>

# V(ariety) o(f) F(iber) O(rientation) Tensors

This repository contains a Python package called `vofotensors`  
which contains most of the parameterizations of fiber orientation tensors
defined in the paper

```bibtex
@article{
  title={Variety of fiber orientation tensors},
  author={Bauer, Julian Karl and B{\"o}hlke, Thomas},
  journal={Mathematics and Mechanics of Solids},
  publisher={SAGE Publications Sage UK: London, England},
  doi={10.1177/10812865211057602},
  volume={27},
  number={7},
  pages={1185-1211},
  year={2022},
}
```

Please see [license][url_license],
[acknowledgment](#acknowledgment)
and cite the [paper given above][url_mms_article] and the latest [Zenodo-DOI][latest_doi].

## Installation

### Install directly from github

```
python -m pip install git+https://github.com/JulianKarlBauer/vofotensors.git
```

### Install from [![PyPI](https://badge.fury.io/py/vofotensors.svg)][url_pypi_this_package]

```bash
pip install vofotensors
```

### Install from local clone

- [Clone][url_how_to_clone] this repository to your machine
- Open a terminal and navigate to your local clone
- Install the package from the local clone into the current [env][url_env_python]i[ronment][url_env_conda] in develop mode:
  ```shell
  python setup.py develop
  ```

Note: [Develop vs. install](https://stackoverflow.com/a/19048754/8935243)

## Examples

Rendered example notebooks are in [the docs][url_read_the_docs_latest_notebooks].
These notebooks and corresponding scripts can be found [here][url_docs_source_notebooks].

## Acknowledgment

The research documented in this repository has been funded by the
[German Research Foundation (DFG, Deutsche Forschungsgemeinschaft)][dfg_website] - project number [255730231][dfg_project].
The support by the German Research Foundation within the International Research Training Group
[“Integrated engineering of continuous-discontinuous long fiber reinforced polymer structures“ (GRK 2078)][grk_website]
is gratefully acknowledged.

[grk_website]: https://www.grk2078.kit.edu/
[dfg_website]: https://www.dfg.de/
[dfg_project]: https://gepris.dfg.de/gepris/projekt/255730231
[latest_doi]: https://zenodo.org/badge/latestdoi/356695831
[url_mms_article]: https://journals.sagepub.com/doi/full/10.1177/10812865211057602
[url_license]: LICENSE
[url_how_to_clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
[url_env_python]: https://docs.python.org/3/tutorial/venv.html
[url_env_conda]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
[url_read_the_docs_latest]: https://vofotensors.readthedocs.io/en/latest/
[url_read_the_docs_latest_notebooks]: https://vofotensors.readthedocs.io/en/latest/source/example_notebooks.html
[url_docs_source_notebooks]: https://github.com/JulianKarlBauer/vofotensors/tree/master/docs/source/notebooks
[url_pypi_this_package]: https://pypi.org/project/vofotensors/