| 1 |
This is the Perl interface to the Ifeffit library. |
| 2 |
|
| 3 |
To build and install this interface: |
| 4 |
|
| 5 |
1. build and INSTALL the ifeffit library. That is, the |
| 6 |
ifeffit library must be installed in its final resting |
| 7 |
place for the perl extension to work properly. |
| 8 |
|
| 9 |
If you're building this from the standard distribution, a |
| 10 |
Makefile.PL file should already be in this directory. If |
| 11 |
not (or if you are building this from the stand-alone perl |
| 12 |
distribution after the Ifeffit library has been installed) |
| 13 |
copy the Makefile.PL from the ifeffit directory: |
| 14 |
|
| 15 |
~> cp /usr/local/share/ifeffit/Makefile.PL . |
| 16 |
|
| 17 |
(the exact location may be different, depending on how |
| 18 |
ifeffit was built and installed). |
| 19 |
|
| 20 |
2. build the Perl interface by typing |
| 21 |
~> perl Makefile.PL |
| 22 |
~> make |
| 23 |
|
| 24 |
The Makefile.PL file should properly reflect your Ifeffit |
| 25 |
installation, and should not require any tweaking. If this |
| 26 |
compilation fails, ask a local Perl expert or send email. |
| 27 |
|
| 28 |
3. test the Perl extension: |
| 29 |
~> make test |
| 30 |
|
| 31 |
If the test fails (you'll see a bunch cryptic error messages), |
| 32 |
first check the 'Fortran.Notes' in the main wrapper directory. |
| 33 |
If that doesn't help, please let me know. |
| 34 |
|
| 35 |
4. install the perl extension: |
| 36 |
~> make install |
| 37 |
|
| 38 |
You'll need write permissions to the normal Perl library, |
| 39 |
which probably means you'll need to be root. |
| 40 |
|
| 41 |
5. The file 'ifeffit_shell.pl' is a friendly command-line interface |
| 42 |
to the ifeffit library. If the Perl Readline Module has been |
| 43 |
installed, then command history and tab completion should work. |
| 44 |
(If in doubt, install the GNU version of the Readline module). |
| 45 |
|
| 46 |
You may want to install this file as 'ifeffit' somewhere in your |
| 47 |
path to use instead of the standard, less-featured C version. You |
| 48 |
may also want to copy (and possibly edit) the two 'run-time |
| 49 |
configuration' files: |
| 50 |
~> cp dot.ifeffitrc $HOME/.ifeffitrc |
| 51 |
~> cp dot.ifeffit_macros $HOME/.ifeffit_macros |
| 52 |
|
| 53 |
Documentation for the Perl Module can be found by typing |
| 54 |
~> perldoc Ifeffit |
| 55 |
|
| 56 |
additional documentation about the command-line program can be |
| 57 |
found by typing 'help' at the command prompt. |
| 58 |
|
| 59 |
|
| 60 |
Matt Newville <[email protected]> |