Documentation for pp_lib

Overview

All pp_lib routines have a page here, generated with IDLDoc. Most of them have complete documentation, including usage examples, but a few are still missing parts of the documentation.

Installation

The whole library is provided in a git repository, which contains the source code (in pp_lib/src) and documentation (in pp_lib/doc). There are no external dependencies.

To install the library, you may simply use git to download the current version and any susbsequent update. One way to do it is:

[user@computer ~]$ git clone git://github.com/ppenteado/pp_lib.git
Cloning into pp_lib...
remote: Counting objects: 56, done.
remote: Compressing objects: 100% (51/51), done.
remote: Total 56 (delta 4), reused 53 (delta 4)
Receiving objects: 100% (56/56), 809.23 KiB | 158 KiB/s, done.
Resolving deltas: 100% (4/4), done.

This will create a directory called pp_lib under the current directory, with a copy of the library. If have done this and want to update your copy of the library to the current version, you can then just get in the pp_lib directory and and do an update:

[user@computer ~]$ cd pp_lib
[user@computer ~]$ git pull
remote: Counting objects: 185, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 100 (delta 96), reused 100 (delta 96)
Receiving objects: 100% (100/100), 45.57 KiB, done.
Resolving deltas: 100% (96/96), completed with 84 local objects.
From git://github.com/ppenteado/pp_lib
   d0bd704..caf1607  master     -> origin/master
Updating d0bd704..caf1607
Fast-forward
 doc/al_legend_pp-code.html               |    2 +-
 doc/al_legend_pp.html                    |    4 +-
 doc/all-dirs.html                        |    2 +-
...
101 files changed, 1310 insertions(+), 198 deletions(-)
...

If you prefer, you can get the library as a zip file.

Then, add the directory pp_lib/src to your IDL path. For help on the many ways to add the directory to the IDL path, you can see IDL's help, or the relevant part in David Fanning's instructions on how to set the path for his libraries.

Citing this library

If you find that this library was useful in your research, please cite it. The BibTeX code for the current release is

\@misc{paulo_penteado_2016_56247,
  author       = {Paulo Penteado},
  title        = {pp_lib v1.1},
  month        = jun,
  year         = 2016,
  doi          = {10.5281/zenodo.56247},
  url          = {http://dx.doi.org/10.5281/zenodo.56247}
}

Links

Repository:
https://github.com/ppenteado/pp_lib

Zip file:
https://github.com/ppenteado/pp_lib/zipball/master

Online documentation:
http://www.ppenteado.net/idl/pp_lib/doc/index.html

Paulo Penteado
pp.penteado@gmail.com
Version 20160622

Project statistics

Directories:	1
.pro files:	58
.sav files:	0
Routines:	115
Lines:	3,582
Required IDL version:	8.0.