Unverified Commit 043698db authored by Stephan Kuschel's avatar Stephan Kuschel Committed by GitHub
Browse files

Merge pull request #258 from skuschel/docs

Docs
parents b9093301 0e5d7101
......@@ -28,7 +28,7 @@ jobs:
strategy:
matrix:
os: [macos-latest, windows-latest]
python-version: [3.x]
python-version: [3.8]
# have to copy steps from above, as anchors are currently
# not supported by github workflow (Jan 2020).
......
# Changelog of postpic
Changelog of postpic
====================
## current master
current master
--------------
**Highlights**
......@@ -30,7 +32,9 @@ field[:, KeepDim(0.0), :].shape == (x,1,z)
* New convenience method `Field.copy`
## v0.4
v0.4
----
2019-01-14
**Highlights**
......@@ -80,12 +84,17 @@ new: `ms = ms.filter('gamma > 2')`
* k-space reconstruction from EPOCH dumps has greatly improved accuracy due to a new algorithm correctly incorporating the frequency response of the implicit linear interpolation performed by EPOCH's half-steps
* `plotter_matplotlib.plotField` allows to override `aspect` option to `imshow`
## v0.3.1
v0.3.1
------
2017-10-03
Only internal changes. Versioning is handled by [versioneer](https://github.com/warner/python-versioneer).
## v0.3
v0.3
----
2017-09-28
Many improvements in terms of speed and features. Unfortunately some changes are not backwards-compatible to v0.2.3, so you may have to adapt your code to the new interface. For details, see the corresponding section below.
......@@ -117,9 +126,9 @@ In case you find particle scalar that you use regularly which is not in the list
* Lots of fixes
v0.2.3
------
## v0.2.3
2017-02-17
This release brings some bugfixes and various new features.
......@@ -135,6 +144,7 @@ This release brings some bugfixes and various new features.
* Lots of performance improvemts: particle data will be much less copied in memory now.
## v0.2.2 and earlier
v0.2.2 and earlier
------------------
There hasnt been any changelog. Dont use those versions anymore.
......@@ -19,7 +19,8 @@ For any coding you need to be familiar with [git](http://git-scm.com/). Its a di
One of the most comprehensive guides is probably [this book](http://git-scm.com/doc). Just start reading from the beginning. It is worth it!
## The Workflow
The Workflow
------------
Adding a feature is often triggered by the personal demand for it. Thats why production ready features should propagte to master as fast as possible. Everything on master is considered to be production ready. We follow the [github-flow](http://scottchacon.com/2011/08/31/github-flow.html) describing this very nicely.
......@@ -44,15 +45,17 @@ In short:
* ensure early feedback on your work
## Coding and general remaks
Coding and general remaks
-------------------------
* Make sure, that the `run-tests.py` script exits without error on EVERY commit. To do so, it is HIGHLY RECOMMENDED to add the `pre-commit` script as the git pre-commit hook. For instructions see [pre-commit](../master/pre-commit).
* Make sure, that the `run-tests.py` script exits without error on EVERY commit. To do so, it is HIGHLY RECOMMENDED to add the `pre-commit` script as the git pre-commit hook. For instructions see [pre-commit](../master/pre-commit).
* The Coding style is according to slightly simplified pep8 rules. This is included in the `run-tests.py` script. If that script runs without error, you should be good to <del>go</del> commit.
* Add the GPLv3+ licence notice on top of every new file. If you add a new file you are free to add your name as a author. This will let other people know that you are in charge if there is any trouble with the code. This is only useful if the file you provide adds functionality like a new datareader. Thats why the `__init__.py` files typically do not have a name written. In doubt, the git revision history will always show who added which line.
What to contribute?
-------------------
## What to contribute?
Here is a list for your inspiration:
......
......@@ -5,7 +5,7 @@ postpic
[![PyPI version](https://badge.fury.io/py/postpic.png)](http://badge.fury.io/py/postpic)
[![Documentation Status](https://readthedocs.org/projects/postpic/badge/?version=latest)](https://postpic.readthedocs.org/)
Postpic is a open-source post processor for Particle-in-cell (PIC) simulations written in python. If you are doing PIC Simulations (likely for you PhD in physics...) you need tools to provide proper post-processing to create nice graphics from many GB of raw simulation output data -- regardless of what simulation code you are using.
Postpic is an open-source post-processor for Particle-in-cell (PIC) simulations written in python. If you are doing PIC Simulations (likely for you PhD in physics...) you need tools to provide proper post-processing to create nice graphics from many GB of raw simulation output data -- regardless of what simulation code you are using.
**For working examples, please go to https://github.com/skuschel/postpic-examples**
......
postpic\.datareader package
===========================
postpic.datareader package
==========================
.. automodule:: postpic.datareader
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
postpic\.datareader\.datareader module
--------------------------------------
postpic.datareader.datareader module
------------------------------------
.. automodule:: postpic.datareader.datareader
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.datareader\.dummy module
---------------------------------
postpic.datareader.dummy module
-------------------------------
.. automodule:: postpic.datareader.dummy
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.datareader\.epochsdf module
------------------------------------
postpic.datareader.epochsdf module
----------------------------------
.. automodule:: postpic.datareader.epochsdf
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.datareader\.openPMDh5 module
-------------------------------------
postpic.datareader.openPMDh5 module
-----------------------------------
.. automodule:: postpic.datareader.openPMDh5
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.datareader\.vsimhdf5 module
------------------------------------
postpic.datareader.vsimhdf5 module
----------------------------------
.. automodule:: postpic.datareader.vsimhdf5
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.io package
===================
postpic.io package
==================
.. automodule:: postpic.io
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
postpic\.io\.common module
--------------------------
postpic.io.common module
------------------------
.. automodule:: postpic.io.common
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.io\.csv module
-----------------------
postpic.io.csv module
---------------------
.. automodule:: postpic.io.csv
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.io\.npy module
postpic.io.image module
-----------------------
.. automodule:: postpic.io.npy
:members:
:undoc-members:
:show-inheritance:
.. automodule:: postpic.io.image
:members:
:undoc-members:
:show-inheritance:
postpic\.io\.vtk module
-----------------------
postpic.io.npy module
---------------------
.. automodule:: postpic.io.vtk
:members:
:undoc-members:
:show-inheritance:
.. automodule:: postpic.io.npy
:members:
:undoc-members:
:show-inheritance:
postpic.io.vtk module
---------------------
.. automodule:: postpic.io.vtk
:members:
:undoc-members:
:show-inheritance:
postpic\.particles package
==========================
postpic.particles package
=========================
.. automodule:: postpic.particles
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
postpic\.particles\.particles module
------------------------------------
postpic.particles.particles module
----------------------------------
.. automodule:: postpic.particles.particles
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.particles\.scalarproperties module
-------------------------------------------
postpic.particles.scalarproperties module
-----------------------------------------
.. automodule:: postpic.particles.scalarproperties
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.plotting package
=========================
postpic.plotting package
========================
.. automodule:: postpic.plotting
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
postpic\.plotting\.plotter\_matplotlib module
---------------------------------------------
postpic.plotting.plotter\_matplotlib module
-------------------------------------------
.. automodule:: postpic.plotting.plotter_matplotlib
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
......@@ -2,45 +2,52 @@ postpic package
===============
.. automodule:: postpic
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 4
postpic.datareader
postpic.io
postpic.particles
postpic.plotting
postpic.datareader
postpic.io
postpic.particles
postpic.plotting
Submodules
----------
postpic\.datahandling module
----------------------------
postpic.datahandling module
---------------------------
.. automodule:: postpic.datahandling
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.experimental module
----------------------------
postpic.experimental module
---------------------------
.. automodule:: postpic.experimental
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic\.helper module
----------------------
postpic.helper module
---------------------
.. automodule:: postpic.helper
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
postpic.helper\_fft module
--------------------------
.. automodule:: postpic.helper_fft
:members:
:undoc-members:
:show-inheritance:
......@@ -22,7 +22,7 @@ import sys
sys.path.insert(0, os.path.abspath('../'))
# numpy and scipy are installed on readthedocs.org
autodoc_mock_imports = ['skimage', 'pyfftw',
autodoc_mock_imports = ['skimage',
'h5py', 'argparse']
# -- General configuration ------------------------------------------------
......@@ -78,7 +78,7 @@ master_doc = 'index'
# General information about the project.
project = 'postpic'
copyright = '2017, the postpic developers'
copyright = '2020, the postpic developers'
author = 'the postpic developers'
# The version info for the project you're documenting, acts as replacement for
......@@ -128,8 +128,7 @@ html_theme_options = {
'github_repo': 'postpic',
'github_banner': True, # fork me on github banner
'github_button': True,
'description': 'the open source partice-in-cell postprocessor.',
'page_width': '1000px',
'description': 'the open-source partice-in-cell postprocessor.'
}
# Add any paths that contain custom static files (such as style sheets) here,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment