Skip to content

Commit 57411f5

Browse files
committed
Update README.
1 parent 284fa38 commit 57411f5

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![LICENSE](https://black.readthedocs.io/en/stable/_static/license.svg)](https://raw.github.com/nilsmeyerkit/fiberoripy/master/LICENSE)
22
[![Documentation Status](https://readthedocs.org/projects/fiberoripy/badge/?version=latest)](https://fiberoripy.readthedocs.io/en/latest/?badge=latest)
3-
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fiberoripy)
3+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fiberoripy)](https://badge.fury.io/py/fiberoripy)
44
[![PyPI version](https://badge.fury.io/py/fiberoripy.svg)](https://badge.fury.io/py/fiberoripy)
55
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
66
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
@@ -11,14 +11,16 @@
1111
This python package provides basic functionality and tools for fiber orientations and
1212
closure models.
1313

14-
For example, the Jupyter Notebook
15-
16-
example/orientation/comparison_perfectshear.ipynb
17-
18-
should reproduce Figure 2 in *Favaloro, A.J., Tucker III, C.L., Composites Part A, 126 (2019)*:
14+
For example, the Jupyter Notebook `example/orientation/comparison_perfectshear.ipynb` should reproduce Figure 2 in *Favaloro, A.J., Tucker III, C.L., Composites Part A, 126 (2019)*:
1915

2016
![example_image](https://raw.github.com/nilsmeyerkit/fiberoripy/master/docs/images/example.png)
2117

18+
## Installation
19+
You may install fiberoripy via pip with
20+
```
21+
pip install fiberoripy
22+
```
23+
2224
## Orientation models
2325
Following models have been implemented:
2426

0 commit comments

Comments
 (0)