Skip to content

Commit 6a5e2a2

Browse files
committed
Updated documentation
1 parent 5899924 commit 6a5e2a2

2 files changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import pylabdd as dd
4848
```
4949

5050
## Speedup with Fortran subroutines
51-
The subroutines to calculate the Peach-Koehler (PK) force on dislocations are rather time consuming. The Fortran implementation of these subroutines brings a considerable seepdup of the simulations compared with the pure Python version. Typically, these faster Fortran subroutines, are automatically created during installation and the embedding into Python is accomplished with the leightweight Fortran wrapper [fmodpy](https://pypi.org/project/fmodpy/). If this process should fail, you will receive a warning and the slower Python subroutines will be used as fallback option. In that case, please report the problem directly to the author or create an issue in the GitHub repo.
51+
The subroutines to calculate the Peach-Koehler (PK) force on dislocations are rather time consuming. The Fortran implementation of these subroutines brings a considerable seepdup of the simulations compared with the pure Python version. Typically, these faster Fortran subroutines, are automatically created during installation and the embedding into Python is accomplished with the leightweight Fortran wrapper [fmodpy](https://pypi.org/project/fmodpy/). Note that this requires a gfortran compiler to be installed in the active envornment. If the compliation of the Fortran subroutines should fail, you will receive a warning and the slower Python subroutines will be used as fallback option. In that case, please check if the gfortran compiler is available. If problems still presist, please report them directly to the author of this packges or create an issue in the GitHub repo.
5252

5353
## Jupyter notebooks
5454

THIRD-PARTY-LICENSES

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
This project makes use of the following third-party Python libraries.
2+
3+
Runtime / build dependencies
4+
----------------------------
5+
- NumPy
6+
License: BSD 3-Clause License
7+
Project: https://numpy.org
8+
License text: https://numpy.org/doc/stable/license.html
9+
10+
- Matplotlib
11+
License: Matplotlib License (PSF-based)
12+
Project: https://matplotlib.org
13+
License text: https://matplotlib.org/stable/users/project/license.html
14+
15+
- fmodpy
16+
License: see upstream LICENSE
17+
Project: https://pypi.org/project/fmodpy/
18+
Source: https://github.com/**(upstream fmodpy repo)**
19+
20+
Test / dev (not distributed with pyLabDD wheels)
21+
-----------------------------------------------
22+
- pytest
23+
License: MIT License
24+
Project: https://pytest.org
25+
License text: https://docs.pytest.org/en/stable/license.html
26+
27+
- black
28+
License: MIT License
29+
Project: https://github.com/psf/black
30+
31+
- build
32+
License: MIT License
33+
Project: https://pypi.org/project/build/
34+
35+
- twine
36+
License: Apache License 2.0
37+
Project: https://pypi.org/project/twine/
38+
39+
Notes
40+
-----
41+
These libraries are not bundled with pyLabDD; they are installed separately
42+
via PyPI or conda(-forge) and include their own license information. This
43+
file is provided for the convenience of users.

0 commit comments

Comments
 (0)