Documentation upgrades, version bump

Project.toml

@@ -1,7 +1,7 @@
 name = "PerturbPlasma"
 uuid = "68cdf181-988b-4042-8999-0b9541c1c3c2"
 authors = ["Mike Petersen <petersen@iap.fr>"]
-version = "0.1.0"
+version = "0.2.0"
 
 [deps]
 FastGaussQuadrature = "442a2c76-b920-505d-bb47-c5924d526838"

README.md

@@ -5,13 +5,17 @@
 
 -----------------------------
 
-## Quick activate
+### Quick activate
 
-In the main directory where you the package lives, enter the Julia environment (`julia`), then the package manager (`]`), then activate (`activate .`). To be extra safe, you can `resolve` to check for updates. Then return to the Julia interpreter (`[backspace]`): you are good to go with the latest version of the package! Import by typing `using PerturbPlasma` into the Julia interpreter. You may also need to download some packages if you are using a new Julia interpreter: try `using(Pkg);Pkg.instantiate()`.
+`PerturbPlasma` is (currently) unregistered, and as such if you would like to add it to your Julia registry, read [here](https://pkgdocs.julialang.org/v1/managing-packages/#Adding-unregistered-packages). Short version: when in the package manager, `add "git@github.com:michael-petersen/PerturbPlasma.git"`. (If you are getting an error about git keys, you will need to register your private key using the julia shell prompt (access with `;`), and then pointing at your private key: `ssh-add ~/.ssh/id_rsa`.) You can verify the current version with `status PerturbPlasma` in the package manager. Then, `import PerturbPlasma` and you are ready to go.
+
+Another option, to work directly from a codebase: in the main directory where you the package lives, enter the Julia environment (`julia`), then the package manager (`]`), then activate (`activate .`). To be extra safe, you can `resolve` to check for updates. Then return to the Julia interpreter (`[backspace]`): you are good to go with the latest version of the package! Import by typing `using PerturbPlasma` into the Julia interpreter. You may also need to download some packages if you are using a new Julia interpreter: try `using(Pkg);Pkg.instantiate()`.
 
 -----------------------------
 
-## Testing Plasma Techniques (Legendre)
+### Testing Plasma Techniques (Legendre)
+
+`tabuGLquad,tabwGLquad = PerturbPlasma.tabuwGLquad(K_u)` will call out for the u positions (tabuGLquad) and corresponding weights (tabwGLquad) at K_u points.
 
 `setup_legendre_integration(K_u,qself,xmax,parallel)` will do the setup work of computing the coefficients at K_u Legendre nodes for a plasma model defined by qself and xmax.
 
@@ -27,7 +31,7 @@ test_ninepointsL(tabaL,20.,structL)
 
 -----------------------------
 
-## Testing Plasma Techniques (Chebyshev)
+### Testing Plasma Techniques (Chebyshev)
 
 `setup_chebyshev_integration(K_u,qself,xmax,parallel)` will do the setup work of computing the coefficients at K_u Legendre nodes for a plasma model defined by qself and xmax.
 
@@ -43,6 +47,6 @@ test_ninepointsC(tabaC,20.)
 
 -----------------------------
 
-## Author
+### Author
 
 Mike Petersen -  @michael-petersen - petersen@iap.fr