Skip to content

Commit dbd1cd5

Browse files
RemiLeheRemiLehe
authored
Merge branch 'dev' into prepare_v2
2 parents eb4e5a8 + 88ab6e1 commit dbd1cd5

38 files changed

+547
-106
lines changed

‎.github/workflows/unix.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
test:
77
strategy:
88
matrix:
9-
python-version: ["3.7", "3.8", "3.9", "3.10"]
9+
python-version: ["3.8", "3.9", "3.10", "3.11"]
1010
os: [ubuntu-20.04]
1111
include:
1212
- python-version: 3.9
@@ -38,7 +38,7 @@ jobs:
3838
if [ "${{ matrix.python-version }}" != "3.8" ]; then
3939
conda install --yes cython numpy scipy h5py openpmd-api matplotlib jupyter pytest pyflakes python=${{ matrix.python-version }} python-wget
4040
else
41-
conda install --yes cython numpy scipy h5py matplotlib jupyter pytest pyflakes python=${{ matrix.python-version }} python-wget
41+
conda install --yes cython numpy scipy h5py matplotlib jupyter pytest pyflakes python=${{ matrix.python-version }} python-wget
4242
fi
4343
4444
- shell: bash -eo pipefail -l {0}

‎.readthedocs.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/source/conf.py
17+
18+
# Optional but recommended, declare the Python requirements required
19+
# to build your documentation
20+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
21+
python:
22+
install:
23+
- requirements: docs/requirements.txt

‎CHANGELOG.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
# Change Log / Release Log for openPMD-viewer
22

3+
## 1.8.0
4+
5+
- The functions `get_field` and `get_particle` now require `iteration` or `t`
6+
to be passed (instead of using a default iteration when none was provided).
7+
(See [#383](https://github.com/openPMD/openPMD-viewer/pull/383))
8+
9+
- The function `get_laser_waist` is more robust and does not crash when the
10+
laser field is 0.
11+
(See [#359](https://github.com/openPMD/openPMD-viewer/pull/359))
12+
13+
- The `FieldMEtaInformation` object has new attributes `time` and `iteration`.
14+
(See [#372](https://github.com/openPMD/openPMD-viewer/pull/372))
15+
16+
- The docstring of `get_mean_gamma` has been updated
17+
(See [#379](https://github.com/openPMD/openPMD-viewer/pull/379))
18+
and the attributes `ts.t` and `ts.iterations` are now shown in the tutorials
19+
(See [#382](https://github.com/openPMD/openPMD-viewer/pull/382))
20+
21+
## 1.7.0
22+
23+
This release includes a few improvements:
24+
25+
- The function `get_laser_waist` is more robust: it does not automatically
26+
assume that the `z` axis is the last axis of the data. In addition, the user
27+
can now specify the laser propagation direction. (The default is `z`.)
28+
(See [#345](https://github.com/openPMD/openPMD-viewer/pull/345))
29+
30+
- The handling of `unitSI` is now more robust. (See [#363](https://github.com/openPMD/openPMD-viewer/pull/363))
31+
332
## 1.6.0
433

534
This release adds a few features:

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# openPMD-viewer
22

33
[![pypi version](https://img.shields.io/pypi/v/openPMD-viewer.svg)](https://pypi.python.org/pypi/openPMD-viewer)
4-
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/main?filepath=tutorials%2F)
4+
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/dev?filepath=docs/source/tutorials%2F)
55
[![License](https://img.shields.io/pypi/l/openPMD-viewer.svg)](LICENSE.txt)
66

77
## Overview
@@ -24,10 +24,10 @@ visualize the data.
2424

2525
The notebooks in the folder `tutorials/` demonstrate how to use both
2626
the API and the interactive GUI. You can view these notebooks online
27-
[here](https://github.com/openPMD/openPMD-viewer/tree/master/tutorials).
27+
[here](https://github.com/openPMD/openPMD-viewer/tree/dev/docs/source/tutorials).
2828

2929
Alternatively, you can even
30-
[*run* our tutorials online](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/master?filepath=tutorials%2F)!
30+
[*run* our tutorials online](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/dev?filepath=docs/source/tutorials%2F)!
3131

3232
You can also download and run these notebooks on your local computer
3333
(when viewing the notebooks with the above link, click on `Raw` to be able to
@@ -93,5 +93,5 @@ notebooks is provided when logging to
9393

9494
## Contributing to the openPMD-viewer
9595

96-
We welcome contributions to the code! Please read [this page](https://github.com/openPMD/openPMD-viewer/blob/master/CONTRIBUTING.md) for
96+
We welcome contributions to the code! Please read [this page](https://github.com/openPMD/openPMD-viewer/blob/dev/CONTRIBUTING.md) for
9797
guidelines on how to contribute.

‎RELEASING.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,6 @@ username = <yourPypiUsername>
3636
correspond to the new release, and that
3737
the corresponding changes have been documented in `CHANGELOG.md`.
3838

39-
- If everything works fine, then merge the `dev` version into `main`
40-
and upload it to Github:
41-
```
42-
git checkout main
43-
git merge dev
44-
git push
45-
```
46-
4739
- Create a new release through the graphical interface on Github
4840

4941
## Uploading the package to PyPI

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
sphinx
2+
sphinx-design
3+
sphinx_rtd_theme
4+
jupyter
5+
nbsphinx
6+
wget
7+
numba
8+
numpy
9+
matplotlib
10+
pygments
11+
scipy
12+
h5py
13+
tqdm
14+
openpmd_viewer

‎docs/source/api_reference/api_reference.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
API reference
2+
=============
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
:caption: Contents:
7+
8+
generic_interface
9+
particle_tracking
10+
lpa_diagnostics

‎docs/source/api_reference/generic_interface.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Generic interface: ``OpenPMDTimeSeries``
2+
----------------------------------------
3+
4+
.. autoclass:: openpmd_viewer.OpenPMDTimeSeries
5+
6+
.. automethod:: get_field
7+
.. automethod:: get_particle
8+
.. automethod:: iterate
9+
.. automethod:: slider

0 commit comments

Comments
 (0)