Skip to content

[doc] updated format for text modificators in release_notes #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Didou09 merged 1 commit into from
Nov 26, 2019
Merged

[doc] updated format for text modificators in release_notes #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions doc/source/release_notes/release_notes_142.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Main changes:
- Major bug fix in one of the methods for computing synthetic signal
- Minor bug fixes in interactive figures
- Minor bug fixes in Plasma2D interpolation
- New configuration (ITER) available
- New configurations (ITER and JET) available
- First version of a class handling 2D XRay bragg spectrometers
- First tools for magnetic field line tracing available on WEST
- Better documentation, more ressources
Expand Down Expand Up @@ -54,12 +54,14 @@ Bug fixes:
- Change default separator in ``to_dict()`` from '_' to '.', #228
- Rays.calc_kInOut_IsoFlux() is now more flexible (accepts 3d np.arrays as well as lists of np.ndarrays), #188
- __repr__() is now overloaded in a more robust way so it falls back to printing the class if get_summary() fails to avoid crashing in debug mode #242
- Minor bug in time interpolation in Plasma2D methods #215


Documentation:
~~~~~~~~~~~~~~
- Updated information about support of python version
- Updated information about support of python version #273
- Added slides of talk given at PyConFR 2019 conference
- Added a ``gallery`` in our documentation with 3 different tutorials:
- Added a **gallery** in our documentation with 3 different tutorials:
- 5 minutes tutorial to show to create a geometry and 1D/2D cameras
- Guide on how to create your own Geometry from scratch (vacuum vessel, structures, etc.)
- How to compute the signal received by a camera using a synthetic signal.
Expand All @@ -72,16 +74,19 @@ Documentation:

New features:
~~~~~~~~~~~~~
- First version of ``magnetic field line tracing`` (for WEST only so far, to be improved) #213 #235
- First version of ``2D XRay Bragg spectrometers`` for synthetic diagnostics, modelling the diagnotics geometry and providing 2d spectral fitting routines (to be improved) #267
- First version of **magnetic field line tracing** (for WEST only so far, to be improved) #213 #235
- First version of **2D XRay Bragg spectrometers** for synthetic diagnostics, modelling the diagnotics geometry and providing 2d spectral fitting routines (to be improved) #267
- When computing a signal ``LOS_calc_signal`` emissivity function can now return
a 1D array if ``t=None`` #217 #252
- Three functions added to ``tf.geom.Rays``: #211
- ``calc_length_in_isoflux()``: compute the length inside a set of isoflux surfaces of each LOS
- ``calc_min_geom_radius()``: compute the minimal geometrical radius (impact parameter) of each LOS
- ``calc_min_rho_from_Plasma2D()``: compute the minimum normalized radius (or any field with a minimum on the axis) for each LOS
- New ``ITER configuration`` available! #220 #227
- New **ITER configuration** available! #220 #227
- New **JET configuration** available! #282
- imas2tofu now more robust with respect to one-time-step only data fields and can handle basic rectangular meshes in addition to triangular meshes #218, #280
- More explicit names for default configurations #264
- The github homepage now includes a badge to the gitter chatroom #277

Contributors:
=============
Expand Down Expand Up @@ -110,6 +115,6 @@ What's next (indicative):

List of issues and PR closed:
=============================
- Issues: #30, #180, #183, #185, #186, #187, #188, #189, #190, #201, #209, #211, #213, #217, #220, #224, #227, #228, #230, #235, #243, #247, #248, #250, #252, #255, #264
- Issues: #30, #180, #183, #185, #186, #187, #188, #189, #190, #201, #209, #211, #213, #215, #217, #218, #220, #224, #227, #228, #230, #235, #243, #247, #248, #250, #252, #255, #264, #277
- PR: #173, #175, #179, #181, #182, #184, #191, #192, #193, #194, #195, #196, #197, #199, #206, #207, #210, #212, #222, #223, #225, #226, #229, #231, #233, #234, #236, #237, #238, #240, #242, #244, #245, #246, #249, #251, #253, #254, #256, #257, #258,
#261, #265, #267
#261, #265, #267, #269, #270, #273, #278, #279, #280, #282
56 changes: 28 additions & 28 deletions release_notes/release_notes_142.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,31 @@ Detailed changes:
Installation / portability:
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Bug fixes for installation on ITER and Gateway clusters #250
- Easier installation on Mac #183 (`requirements.txt`)
- Removed explicit compiler specification in `setup.py` for more flexibility
- Easier installation on Mac #183 (``requirements.txt``)
- Removed explicit compiler specification in ``setup.py`` for more flexibility
- When sub-packages imas2tofu or mag are missing, the warning is much more concise, but the error traceback is still accessible in a hidden dictionnary for developpers #243
- `python setup.py clean` now doesn't cythonize
- ``python setup.py clean`` now doesn't cythonize
- Dropped python 2 support: #228
- merged `_GG02` and `_GG03` into the `_GG` file
- merged ``_GG02`` and ``_GG03`` into the ``_GG`` file
- no longer being tested in travis
- no longer packaged in conda
- updated README file accordingly
- dropped `funcsigs` dependency
- made necessary changes in `setup.py`
- `benchmarks/calc_signal_benchmark.py`: now working with python 3
- dropped ``funcsigs`` dependency
- made necessary changes in ``setup.py``
- ``benchmarks/calc_signal_benchmark.py``: now working with python 3

Bug fixes:
~~~~~~~~~~
- Major bug fix in `LOS_calc_signal()` for computing the synthetic signal of a LOS camera using a particular algortihm : method='sum', minimize='hybrid', ani=True, #247 #255
- Major bug fix in `LOS_get_sample()` when `minimize='hybrid'` and `minimize='memory'` the limits were not set correctly
in some cases the formula for sampling a LOS was wrong (`los_get_sample_core_var_res`).
- Minor bug fixes in interactive figures when `t=None` was used (the interactivity was lost due to wrong formatting of the time array)
- Minor bug fixed in Plasma 2D interpolation (`interp_t` was not being set), imporved error messages #209
- Removed unused variable in `_Ves_get_sampleS` (_GG), in `_core.py` #190
- Gave more explicit names to some variables in `_core.py` to avoid bugs/typos (eg. `I` to `current`) #186
- Removed a secondary `init` function for the class `tf.geom.CoilsPF` #187
- `_checkformat_inputs_dgeom` now is a function of `Rays` class
- Change default separator in `to_dict()` from '_' to '.', #228
- Major bug fix in ``LOS_calc_signal()`` for computing the synthetic signal of a LOS camera using a particular algortihm : method='sum', minimize='hybrid', ani=True, #247 #255
- Major bug fix in ``LOS_get_sample()`` when ``minimize='hybrid'`` and ``minimize='memory'`` the limits were not set correctly
in some cases the formula for sampling a LOS was wrong (``los_get_sample_core_var_res``).
- Minor bug fixes in interactive figures when ``t=None`` was used (the interactivity was lost due to wrong formatting of the time array)
- Minor bug fixed in Plasma 2D interpolation (``interp_t`` was not being set), imporved error messages #209
- Removed unused variable in ``_Ves_get_sampleS`` (_GG), in ``_core.py`` #190
- Gave more explicit names to some variables in ``_core.py`` to avoid bugs/typos (eg. ``I`` to ``current``) #186
- Removed a secondary ``init`` function for the class ``tf.geom.CoilsPF`` #187
- ``_checkformat_inputs_dgeom`` now is a function of ``Rays`` class
- Change default separator in ``to_dict()`` from '_' to '.', #228
- Rays.calc_kInOut_IsoFlux() is now more flexible (accepts 3d np.arrays as well as lists of np.ndarrays), #188
- __repr__() is now overloaded in a more robust way so it falls back to printing the class if get_summary() fails to avoid crashing in debug mode #242
- Minor bug in time interpolation in Plasma2D methods #215
Expand All @@ -61,7 +61,7 @@ Documentation:
~~~~~~~~~~~~~~
- Updated information about support of python version #273
- Added slides of talk given at PyConFR 2019 conference
- Added a `gallery` in our documentation with 3 different tutorials:
- Added a **gallery** in our documentation with 3 different tutorials:
- 5 minutes tutorial to show to create a geometry and 1D/2D cameras
- Guide on how to create your own Geometry from scratch (vacuum vessel, structures, etc.)
- How to compute the signal received by a camera using a synthetic signal.
Expand All @@ -74,16 +74,16 @@ Documentation:

New features:
~~~~~~~~~~~~~
- First version of `magnetic field line tracing` (for WEST only so far, to be improved) #213 #235
- First version of `2D XRay Bragg spectrometers` for synthetic diagnostics, modelling the diagnotics geometry and providing 2d spectral fitting routines (to be improved) #267
- When computing a signal `LOS_calc_signal` emissivity function can now return
a 1D array if `t=None` #217 #252
- Three functions added to `tf.geom.Rays`: #211
- `calc_length_in_isoflux()`: compute the length inside a set of isoflux surfaces of each LOS
- `calc_min_geom_radius()`: compute the minimal geometrical radius (impact parameter) of each LOS
- `calc_min_rho_from_Plasma2D()`: compute the minimum normalized radius (or any field with a minimum on the axis) for each LOS
- New `ITER configuration` available! #220 #227
- New `JET configuration` available! #282
- First version of **magnetic field line tracing** (for WEST only so far, to be improved) #213 #235
- First version of **2D XRay Bragg spectrometers** for synthetic diagnostics, modelling the diagnotics geometry and providing 2d spectral fitting routines (to be improved) #267
- When computing a signal ``LOS_calc_signal`` emissivity function can now return
a 1D array if ``t=None`` #217 #252
- Three functions added to ``tf.geom.Rays``: #211
- ``calc_length_in_isoflux()``: compute the length inside a set of isoflux surfaces of each LOS
- ``calc_min_geom_radius()``: compute the minimal geometrical radius (impact parameter) of each LOS
- ``calc_min_rho_from_Plasma2D()``: compute the minimum normalized radius (or any field with a minimum on the axis) for each LOS
- New **ITER configuration** available! #220 #227
- New **JET configuration** available! #282
- imas2tofu now more robust with respect to one-time-step only data fields and can handle basic rectangular meshes in addition to triangular meshes #218, #280
- More explicit names for default configurations #264
- The github homepage now includes a badge to the gitter chatroom #277
Expand Down