Skip to content

Commit

Permalink
poke at documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceravel committed Jul 10, 2015
1 parent 460847b commit 86fb4b7
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 16 deletions.
13 changes: 7 additions & 6 deletions wrappers/C/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@ contains examples of their use in C programs.

## Memory testing

If the wrappers have memory leaks or other memory use problems, the
wrappers for other languages will suffer from problems that are very
If the C libraries have memory leaks or other memory use problems, the
bindings to other languages will suffer from problems that are very
hard to understand and track down. It is, therefore, a *very* good
idea to use a tool like [Valgrind](http://valgrind.org/) to test
`makepath`, `errors`, and `makephases` whenever changes are made to
the libraries.
`makepath`, `errors`, `makephases`, and `pherr` whenever changes are
made to the libraries.

Using [Valgrind](http://valgrind.org/) like so work wonders:
Using [Valgrind](http://valgrind.org/) like so works wonders:

~> valgrind --track-origins=yes --leak-check=full --show-leak-kinds=all ./makepath
~> valgrind --track-origins=yes --leak-check=full --show-leak-kinds=all ./errors
~> valgrind --track-origins=yes --leak-check=full --show-leak-kinds=all ./makephases
~> valgrind --track-origins=yes --leak-check=full --show-leak-kinds=all ./pherr

If you can get the programs to run without any error reports from
Valgrind, the wrappers for other languages will have a fighting chance
Valgrind, the bindings to other languages will have a fighting chance
of working correctly.
15 changes: 8 additions & 7 deletions wrappers/C/README_phases.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ That's it!

## Sample program

Here is the simplest program using the C wrapper:
Here is the simplest program using the C wrapper in `libfeffphases`:

```C
#include <stdio.h>
Expand Down Expand Up @@ -53,7 +53,7 @@ int main()

1. The `feffphases.h` header file is included.

2. A FEFFPHASES struct is created and called `phases`. Memory is
2. A FEFFPHASES struct is created and is named `phases`. Memory is
allocated for it.

3. The call to `create_phases` allocates memory for all elements of the
Expand Down Expand Up @@ -133,11 +133,12 @@ errors are found.

### A note about Feff screen messages

The default is to suppress Feff's many screen messages. No effort is
made to capture the path to convergence when computing self-consistent
potentials. In order to preserve that information, you must set
`verbose` to true then somehow capture and parse the screen output.
This is left as a chore for the user interface.
The default is to suppress Feff's many screen messages, ie. `verbose`
is false by default. No effort is made to capture the path to
convergence when computing self-consistent potentials. In order to
preserve that information, you must set `verbose` to true then somehow
capture and parse the screen output. This is left as a chore for the
user interface.

### Attributes to consider trimming

Expand Down
7 changes: 4 additions & 3 deletions wrappers/fortran/README_potph.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ That's it!

## Sample program

Here is the simplest program using the Fortran entry point:
Here is the simplest program using the Fortran entry point in
`libpotph`:

```fortran
program makepotph
Expand Down Expand Up @@ -76,7 +77,7 @@ Here is the simplest program using the Fortran entry point:

1. All the necessary variables are typed, dimensioned, and initialized.

2. Everything gets initialized. Note that rfms1 is single precision,
2. Everything gets initialized. Note that `rfms1` is single precision,
not double.

3. Read the values of parameters from `feff.inp`, which were written
Expand All @@ -93,7 +94,7 @@ Here is the simplest program using the Fortran entry point:

6. Call the libpotph library, which sorts the input cluster, computes
the muffin tin potentials, and writes phase shifts to a file
as specified by the phpad argument..
as specified by the phpad argument.

## Arguments of the libpotph subroutine

Expand Down

0 comments on commit 86fb4b7

Please sign in to comment.