diff options
| author |  Remi Lehe <remi.lehe@normalesup.org>
| 2018-09-28 13:33:36 -0700 |
|---|---|---|
| committer | Remi Lehe <remi.lehe@normalesup.org>
| 2018-09-28 13:33:36 -0700 |
| commit | bde6e2357dc79bdabbdb7421c995d24d5a17d5be (patch) | |
| tree | 87aa3b6b255f40b3c343a6b627d594cbe52a776c /Docs/source/visualization | |
| parent | 9f0f6ff5664b8106fdfff4db0d994757aa7e3c75 (diff) | |
| download | WarpX-bde6e2357dc79bdabbdb7421c995d24d5a17d5be.tar.gz WarpX-bde6e2357dc79bdabbdb7421c995d24d5a17d5be.tar.zst WarpX-bde6e2357dc79bdabbdb7421c995d24d5a17d5be.zip | |
Update documentation for PICviewer
Diffstat (limited to 'Docs/source/visualization')
| -rw-r--r-- | Docs/source/visualization/pyside.rst | 67 |
1 files changed, 40 insertions, 27 deletions
diff --git a/Docs/source/visualization/pyside.rst b/Docs/source/visualization/pyside.rst index 1c39b216c..a20aefe81 100644 --- a/Docs/source/visualization/pyside.rst +++ b/Docs/source/visualization/pyside.rst @@ -1,14 +1,15 @@ PySide-based visualization GUI: PICViewer -================ +========================================= -.. figure:: sample_image_png +.. figure:: sample_image.png :alt: picture The toolkit provides various easy-to-use functions for data analysis of Warp/WarpX simulations. -## Main features +Main features +------------- * 2D/3D openPMD or WarpX data visualization, * Multi-plot panels (up to 6 rows x 5 columns) controllable independently or synchronously @@ -18,49 +19,61 @@ Warp/WarpX simulations. * Interface to use VisIt, yt, or mayavi for 3D volume rendering (currently updating) -## Required software -* python 2.7 or higher: -http://docs.continuum.io/anaconda/install. +Required software +----------------- + +* python 2.7 or higher: http://docs.continuum.io/anaconda/install. * PySide -``` -conda install -c conda-forge pyside -``` + + :: + + conda install -c conda-forge pyside + * h5py + * matplotlib + * numpy + * yt -``` -pip install git+https://github.com/yt-project/yt.git --user -``` + + :: + + pip install git+https://github.com/yt-project/yt.git --user + * numba Installation ------------ -``` -pip install picviewer -``` +:: + + pip install picviewer + You need to install yt and PySide separately. You can install from the source for the latest update, -``` -pip install git+https://bitbucket.org/jaehong2013/picviewer/ -``` -## To install manually +:: -* Clone this repository -``` -git clone https://jaehong2013@bitbucket.org/jaehong2013/picviewer.git -``` + pip install git+https://bitbucket.org/jaehong2013/picviewer/ -* Switch to the cloned directory with `cd picviewer` and type `python setup.py install` -## To run +To install manually +------------------- -* You can start PICViewer from any directory. Type `picviewer` in the command line. Select a folder where your data files are located. -* You can directly open your data. Move on to a folder where your data files ae located (`cd [your data folder]`) and type `picviewer` in the command line. +* Clone this repository + + :: + git clone https://jaehong2013@bitbucket.org/jaehong2013/picviewer.git +* Switch to the cloned directory with `cd picviewer` and type `python setup.py install` + +To run +------ + +* You can start PICViewer from any directory. Type `picviewer` in the command line. Select a folder where your data files are located. +* You can directly open your data. Move on to a folder where your data files ae located (`cd [your data folder]`) and type `picviewer` in the command line. |