Skip to content

Commit

Permalink
Docs: Fix Typos Titles
Browse files Browse the repository at this point in the history
Headlines are capitalized for most words
  • Loading branch information
ax3l committed Oct 16, 2018
1 parent 562a7ad commit f830e53
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 19 deletions.
9 changes: 6 additions & 3 deletions docs/source/dev/py_postprocessing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _development-pytools:

Python postprocessing tool structure
Python Postprocessing Tool Structure
====================================

Each plugin should implement at least the following Python classes.
Expand All @@ -11,8 +11,9 @@ Each plugin should implement at least the following Python classes.
via other widgets.
The repository directory for PIConGPU Python modules for plugins is ``lib/python/picongpu/plugins/``.

Data reader
Data Reader
~~~~~~~~~~~

The data readers should reside in the ``lib/python/picongpu/plugins/data`` directory.
There is a base class in ``base_reader.py`` defining the interface of a reader.
Each reader class should derive from this class and needs to implement the following interface functions:
Expand All @@ -25,6 +26,7 @@ To shorten the import statements for the readers, please also add an entry in th

Visualizer
~~~~~~~~~~

The visualizers should reside in the ``lib/python/picongpu/plugins/plot_mpl/`` directory.
The module names should end on ``_visualizer.py`` and the class name should only be ``Visualizer``.

Expand Down Expand Up @@ -66,8 +68,9 @@ This is called only after a valid ``self.plt_obj`` was created.
It updates the matplotlib artist with new data.
Therefore it again needs to access the plotting data from the ``self.data`` member and call the data update API for the matplotlib artist (normally via ``.set_data(...)``.

Jupyter widget
Jupyter Widget
~~~~~~~~~~~~~~

The widget is essentially only a wrapper around the matplotlib visualizer that allows dynamical adjustment of the parameters the visualizer accepts for plotting.
This allows to adjust e.g. species, filter and other plugin-dependent options without having to write new lines of Python code.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Examples
* ``42,30:50:10``: at steps 30 40 42 50 84 126 168 ...
* ``5,10``: at steps 0 5 10 15 20 25 ... (only executed once per step in overlapping intervals)

Python postprocessing
Python Postprocessing
=====================

In order to further work with the data produced by a plugin during a simulation run, PIConGPU provides python tools that can be used for reading data and for visualization (at the moment only for energy_histogram, PNG and phase_space).
Expand Down
8 changes: 4 additions & 4 deletions docs/source/usage/plugins/energyHistogram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Each row describes another simulation time step.
Analysis Tools
^^^^^^^^^^^^^^

Data reader
Data Reader
"""""""""""
You can quickly load and interact with the data in Python with:

Expand All @@ -99,7 +99,7 @@ You can quickly load and interact with the data in Python with:
eh_reader = EnergyHistogramData('/home/axel/runs/lwfa_001')
counts, bins = eh_reader.get(species='e', species_filter='all', iteration=2000)
Matplotlib visualizer
Matplotlib Visualizer
"""""""""""""""""""""

You can quickly plot the data in Python with:
Expand Down Expand Up @@ -154,7 +154,7 @@ Argument Value



Jupyter widget
Jupyter Widget
""""""""""""""

If you want more interactive visualization, then start a jupyter notebook and make
Expand All @@ -181,4 +181,4 @@ After starting the notebook server write the following
v = EnergyHistogramVisualizer(experiment_path="path/to/scan/outputs")
display(v)
and then interact with the displayed widgets.
and then interact with the displayed widgets.
9 changes: 3 additions & 6 deletions docs/source/usage/plugins/phaseSpace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In order to scale to a simpler *charge of particles* per :math:`\mathrm{d}r_i` a
Analysis Tools
^^^^^^^^^^^^^^

Data reader
Data Reader
"""""""""""
You can quickly load and interact with the data in Python with:

Expand All @@ -75,9 +75,7 @@ You can quickly load and interact with the data in Python with:
Note that the spatial extent of the output over time might change when running a moving window simulation.



Matplotlib visualizer
Matplotlib Visualizer
"""""""""""""""""""""

You can quickly plot the data in Python with:
Expand Down Expand Up @@ -116,8 +114,7 @@ Options Value
-m (optional, defaults to 'ypy') Momentum string to specify the phase space
================================ =======================================================


Jupyter widget
Jupyter Widget
""""""""""""""

If you want more interactive visualization, then start a jupyter notebook and make
Expand Down
9 changes: 4 additions & 5 deletions docs/source/usage/plugins/png.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ This naming convention allows to put all pngs in one directory and still be able
Analysis Tools
^^^^^^^^^^^^^^

Data reader
Data Reader
"""""""""""

You can quickly load and interact with the data in Python with:
Expand All @@ -269,7 +269,7 @@ You can quickly load and interact with the data in Python with:
pngs[iters[0]].shape
Matplotlib visualizer
Matplotlib Visualizer
"""""""""""""""""""""

If you are only interested in visualizing the generated png files it is
Expand Down Expand Up @@ -310,8 +310,7 @@ Options Value
-o (optional, defaults to 'None') A float between 0 and 1 for slice offset along the third dimension
================================= ==================================================================


Jupyter widget
Jupyter Widget
""""""""""""""

If you want more interactive visualization, then start a jupyter notebook and make
Expand Down Expand Up @@ -340,4 +339,4 @@ After starting the notebook server write the following
display(v)
and then interact with the displayed widgets.
and then interact with the displayed widgets.

0 comments on commit f830e53

Please sign in to comment.