Skip to content

Add note about RAM issues to README.md #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 28, 2020
Merged

Add note about RAM issues to README.md #282

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
75a614b
add note about RAM issues
jvdp1 Dec 27, 2020
e314a28
Update README.md
jvdp1 Dec 27, 2020
9c6bbbe
Update README.md
jvdp1 Dec 28, 2020
f9febba
Apply suggestions from code review as proposed by @milancurcic
jvdp1 Dec 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,25 @@ Alternatively, you can build using provided Makefiles:
make -f Makefile.manual
```

## Limiting the maximum rank of generated procedures

Stdlib's preprocessor (fypp) by default generates specific procedures for arrays of all ranks, up to rank 15.
This can result in long compilation times and, on some computers, exceeding available memory.
If you know that you won't need all 15 ranks, you can specify the maximum rank for which the specific procedures will be generated.
For example, with CMake:

```sh
cmake -B build -DCMAKE_MAXIMUM_RANK=4
cmake --build build
cmake --build build --target test
```
or as follows with `make`:

```sh
make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4
```
Note that currently the minimum value for maximum rank is 4.

## Documentation

Documentation is a work in progress (see issue #4) but is currently available at https://stdlib.fortran-lang.org.
Expand Down