From bf7b76599e160ace02eb25cb8acad1a64e155522 Mon Sep 17 00:00:00 2001 From: Martin Jucker Date: Tue, 27 May 2014 14:28:23 -0400 Subject: [PATCH] Updated README for installation options --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0735292..766a0b6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -pv-atmos +pv_atmos ======== -Python scripting for scientific visualization software [ParaView](http://www.paraview.org). In particular, pv-atmos contains routines for visualizing data from geophysical netCDF data. +Python scripting for scientific visualization software [ParaView](http://www.paraview.org). In particular, pv_atmos contains routines for visualizing data from geophysical netCDF data. No Python outside ParaView is needed, as ParaView ships with its own distribution. +If, on the other hand, pv_atmos shall be used as a python package outside the ParaView python console, make sure paraview.simple is in the python path. + ### atmos_basic Provides functionality to read data on a latitude - longitude and, if desired, pressure or height coordinates grid, including time evolution (if present) from a netCDF file. The netCDF should loosely correspond to the [Climate and Forecast (FC) conventions](https://en.wikipedia.org/wiki/Climate_and_Forecast_Metadata_Conventions). The important attribute is the time coordinate: ParaView will be looking for the "units: xxxx since xxxx" attribute to decide which dimension corresponds to time. @@ -21,12 +23,16 @@ These routines are not limited to any kind of data, and can be used with any dat Releases -------- -The release directory containes published releases as .zip packages for easy referral and version control. +See releases with changelogs in the releases panel of the GitHub distribution. Installation & Use ------------------ -No python installation and/or command shell is needed. Download the .zip release file, unpack it where convenient. Start ParaView, and open the Python Shell contained within ParaView. Type "import math". If the pv-atmos files are not unpacked in the run directory, use the "run script" button and choose atmos_basic.py first, atmos_grids.py second, and you are ready to use the pv-atmos functions. +1) For use in the ParaView python console: +No python installation and/or command shell is needed. Download the .zip file, unpack it where convenient. Start ParaView, and open the Python Shell contained within ParaView. If the pv_atmos files are not unpacked in the run directory, use the "run script" button and choose atmos_basic.py first, atmos_grids.py second, and you are ready to use the pv_atmos functions. + +2) For use as independent python package: +Run 'python setup.py install' in the command line within the downloaded directory. This will install the package pv_atmos and you can run 'from pv_atmos import atmos_basic' or 'from pv_atmos import atmos_grids'. Examples @@ -44,4 +50,4 @@ Remarks ------- Input netCDF files should generally conform to the Climate and Forecast (CF) metadata convention. A not so rigorous but sufficient test is to load the file manually into ParaView, and select "CF" convention; if ParaView reads in the data, the here included scripts can be used without problems. -For instance, the time coordinate does not have to conform to CF conventions, in particular the "calendar" attribute: The important thing to make ParaView accept "time" as time is the attribute "units", which must contain the word "since". \ No newline at end of file +For instance, the time coordinate does not have to conform to CF conventions, in particular the "calendar" attribute: The important thing to make ParaView accept "time" as time is the attribute "units", which must contain the word "since".