Skip to content

Commit

Permalink
remove LiveViewPlugin documentation
Browse files Browse the repository at this point in the history
remove all documentations for the plugin
  • Loading branch information
psychocoderHPC committed Sep 11, 2017
1 parent b02c1af commit 1b39c96
Show file tree
Hide file tree
Showing 9 changed files with 6 additions and 25 deletions.
7 changes: 0 additions & 7 deletions docs/TBG_macros.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,6 @@ TBG_isaac_resolution="--isaac.width 1024 --isaac.height 768"
TBG_isaac_pause="--isaac.directPause"
TBG_isaac_reconnect="--isaac.reconnect false"

# Connect to a live-view server (start the server in advance)
TBG_liveViewYX="--<species>_liveView.period 1 --<species>_liveView.slicePoint 0.5 --<species>_liveView.ip 10.0.2.254 \
--<species>_liveView.port 2020 --<species>_liveView.axis yx"
TBG_liveViewYZ="--<species>_liveView.period 1 --<species>_liveView.slicePoint 0.5 --<species>_liveView.ip 10.0.2.254 \
--<species>_liveView.port 2021 --<species>_liveView.axis yz"


# Print the maximum charge deviation between particles and div E to textfile 'chargeConservation.dat':
TBG_chargeConservation="--chargeConservation.period 100"

Expand Down
1 change: 0 additions & 1 deletion docs/source/usage/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Plugin name sh
:ref:`HDF5 <usage-plugins-HDF5>` [#f2]_ stores simulation data as libSplash-flavoured HDF5 files
:ref:`ISAAC <usage-plugins-ISAAC>` interactive 3D live visualization
:ref:`intensity <usage-plugins-intensity>` [#f1]_ [#f5]_ maximum and integrated electric field along the y-direction
:ref:`live view module <usage-plugins-liveView2D>` [#f5]_ png based 2D live output
:ref:`particle calorimeter <usage-plugins-particleCalorimeter>` [#f3]_ [#f4]_ spatially resolved, particle energy detector in infinite distance
:ref:`particle merger <usage-plugins-particleMerger>` macro particle merging
:ref:`phase space <usage-plugins-phaseSpace>` [#f3]_ calculate 2D phase space
Expand Down
11 changes: 0 additions & 11 deletions docs/source/usage/plugins/liveView2D.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/usage/plugins/png.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ The data structures used are those available in PIConGPU.

.. code:: cpp
/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1( float3_X const & field_B, float3_X const & field_E, float3_X const & field_J )
{
/* Channel1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ namespace picongpu
namespace preChannel2Col = colorScales::green;
namespace preChannel3Col = colorScales::none;

/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1(const float3_X& field_B, const float3_X& field_E, const float3_X& field_J)
{
return math::abs2(field_J);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace preChannel1Col = colorScales::blue;
namespace preChannel2Col = colorScales::green;
namespace preChannel3Col = colorScales::none;

/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1(const float3_X& field_B, const float3_X& field_E, const float3_X& field_J)
{
return math::abs2(field_J);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace picongpu
namespace preChannel2Col = colorScales::green;
namespace preChannel3Col = colorScales::none;

/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1 ( const float3_X& field_B, const float3_X& field_E, const float3_X& field_J )
{
return field_B.z();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace preChannel1Col = colorScales::green;
namespace preChannel2Col = colorScales::none;
namespace preChannel3Col = colorScales::none;

/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1(const float3_X& field_B, const float3_X& field_E, const float3_X& field_J)
{
return field_E.x() * field_E.x();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace picongpu
namespace preChannel2Col = colorScales::green;
namespace preChannel3Col = colorScales::none;

/* png preview and liveview settings for each channel */
/* png preview settings for each channel */
DINLINE float_X preChannel1 ( const float3_X& field_B, const float3_X& field_E, const float3_X& field_J )
{
return field_B.x()*field_B.x() + field_B.y()*field_B.y();
Expand Down

0 comments on commit 1b39c96

Please sign in to comment.