Release 1.4

What's Changed

New features

• TXTExport refactoring by @KulaginVladimir in #883
• Average surface and volume derived quantities in Cylindrical and Spherical by @jhdark in #820
• Total surface and volume derived quantities for cylindrical and spherical meshes by @jhdark in #939
• QoL: provide Stepsize as float or int by @jhdark in #936
• Printing messages in parallel runs by @jhdark in #937

Deprecations

• Deprecate MeshFromRefinements by @RemDelaporteMathurin in #893
• Deprecate list attributes by @jhdark in #935

Bug fixes

• Wrong value for error_on_nonconvergence in NewtonSolver by @KulaginVladimir in #874
• Fix for no borders in multi-materials sims by @RemDelaporteMathurin in #927
• Fix for spherical (cylindrical) coordinates in non-1D (3D) by @KulaginVladimir in #929

Documentation

• Documentation: typo value not in code #843 by @XinShen-CHN in #858
• Add University of Tsukuba on the user map by @iamryo in #853
• Sphinx docs files to gitignore by @RemDelaporteMathurin in #859
• Details for contribution workflow by @RemDelaporteMathurin in #865
• Store user logos locally to avoid missing markers in map by @XinShen-CHN in #862
• Add the slack channel. by @XinShen-CHN in #867
• Documentation dead links #840 by @XinShen-CHN in #868
• added WSL and Anaconda instructions by @rekomodo in #872
• Documentation: how to run FESTIM in parallel #856 by @XinShen-CHN in #871
• Cards on front page of docs by @RemDelaporteMathurin in #890
• New pip commands in documentation by @RemDelaporteMathurin in #891
• Update begginer's guide by @kaelyndunnell in #915
• GMSH workflow by @celyneira in #885
• fenicsx installation instructions by @RemDelaporteMathurin in #917
• added styling by @RemDelaporteMathurin in #924
• UPD of developer's guide and docs for materials by @KulaginVladimir in #930
• Update docs env by @RemDelaporteMathurin in #932
• Theory page fix by @RemDelaporteMathurin in #934

Distribution

• moving setup.cfg and setup.py to pyproject.toml by @shimwell in #877

Misc

• Removed unused imports by @NeelKondapalli in #851
• Fix incorrect error message on SurfaceFluxCylindrical by @rekomodo in #881
• Better error message for divergence with no dt_min by @RemDelaporteMathurin in #889
• Update conda action by @RemDelaporteMathurin in #928
• New default value for DerivedQuantities.show_units by @RemDelaporteMathurin in #892

New Contributors

• @NeelKondapalli made their first contribution in #851
• @iamryo made their first contribution in #853
• @celyneira made their first contribution in #885

Full Changelog: v1.3.1...v1.4

Patch 1.3.1

This PR includes a couple of bug fixes that were identified right after the 1.3 release.

Upgrading FESTIM is only required if you are using SurfaceFlux in combination with the Soret effect.

• Fix SurfaceFlux with Soret by @RemDelaporteMathurin in #831
• allowed_meshes property for derived quantities by @RemDelaporteMathurin in #832
• Fixed Simulation.exports setter by @RemDelaporteMathurin in #836
• Correct units for cylindrical and spherical fluxes by @RemDelaporteMathurin in #835

Full Changelog: v1.3...v1.3.1

Release 1.3

What's Changed

1.3 is out! One of the biggest releases so far! Lots of new functionalities, bug fixes and quality of life improvements!

We encourage users to upgrade their FESTIM version with

pip install -U festim

🌟 Highlights 🌟

• Custom solver
  Users can now use a custom newton solver and have a finer control on the solver parameters (pre-conditioners, linear solvers...)
• Kinetic surface model
  Similar to the model of Pick & Sonnenberg for surface dynamics, it is now possible to have a kinetic surface model in 1D simulations

New features

• Custom solver by @KulaginVladimir in #734
• SurfaceKinetics BC by @KulaginVladimir in #791
• Units in title for derived quantities by @jhdark in #736
• Cylindrical and spherical versions of SurfaceFlux by @RemDelaporteMathurin in #689
• Soret effect in cylindrical and spherical coordinates by @KulaginVladimir in #823

Bug fixes

• Fix bug with XDMF export in mode last by @RemDelaporteMathurin in #796
• Fixing the timer to stop at the end of a simulation. by @Allentro in #713
• Fix bug with trap id is None by @KulaginVladimir in #810

QoL improvements

• Temperature can be given as float or sp.Expr by @RemDelaporteMathurin in #770
• Error message when temperature is not defined by @RemDelaporteMathurin in #768
• Add error message when no final time is provided in transient simulations by @RemDelaporteMathurin in #769
• IC improvements for Heat Transfer by @RemDelaporteMathurin in #774
• Reset derived quantities data by @RemDelaporteMathurin in #772
• Error if temperature BC or source with F.Temperature by @JonathanGSDUFOUR in #812

Documentation

• Test documentation code blocks by @RemDelaporteMathurin in #780
• Update the information in the XDMF section by @XinShen-CHN in #801
• Add DissociationFlux to API documentation by @RemDelaporteMathurin in #707
• Add roadmap to README and change layout by @RemDelaporteMathurin in #709
• Update citation and add missing publications by @RemDelaporteMathurin in #717
• Adding copy button to the documentation by @Allentro in #716
• Adds NumFOCUS sponsorship by @RemDelaporteMathurin in #763
• Map of institutions in documentation by @RemDelaporteMathurin in #761
• Additional buttons in header by @RemDelaporteMathurin in #762
• Update docstrings for Temperature by @RemDelaporteMathurin in #771
• Documentation: stepsize and Newton Solver by @KulaginVladimir in #777
• Documentation guide by @RemDelaporteMathurin in #779
• SALOME meshing guide by @RemDelaporteMathurin in #776
• Fix user map + new institutions by @RemDelaporteMathurin in #786
• Move icons to header in docs by @RemDelaporteMathurin in #794
• Fix attributes typo in docs by @RemDelaporteMathurin in #795
• Docs fixes by @RemDelaporteMathurin in #797
• SurfaceKinetics docs and form by @KulaginVladimir in #805
• Add ornl by @jbae11 in #809
• List of maintainers in docs by @RemDelaporteMathurin in #815
• Radioactive decay in Theory by @RemDelaporteMathurin in #816
• Filter method docs by @RemDelaporteMathurin in #817
• Theory and UG for the SurfaceKinetics BC by @KulaginVladimir in #808
• Fixed the typo in ExtrinsicTrap docstring[Issue #825] by @muddi900 in #826

Misc

• Old comment on cylindrical flux by @RemDelaporteMathurin in #722
• Small refactoring of tests by @KulaginVladimir in #726
• Fix codecov upload by @RemDelaporteMathurin in #757
• added TotalVolume to allowed cartesian quantities by @RemDelaporteMathurin in #766
• Fix units for "retention" with TotalVolume and TotalSurface by @RemDelaporteMathurin in #767
• Fix warnings + remove warnings in test by @RemDelaporteMathurin in #773
• Assign traps ids before by @RemDelaporteMathurin in #822
• No python version in CI by @RemDelaporteMathurin in #827
• Fixing typo Ellapsed -> Elapsed by @Allentro in #714

New Contributors

• @XinShen-CHN made their first contribution in #801
• @jbae11 made their first contribution in #809
• @muddi900 made their first contribution in #826

Full Changelog: v1.2.1...v1.3

Patch 1.2.1

Fix for backward compatibility related to the recent refactoring of DerivedQuantities Exports Traps and Materials #725

Full Changelog: v1.2...v1.2.1

Release 1.2

New features

• TXTExport features by @KulaginVladimir in #676
• Radioactive decay by @RemDelaporteMathurin in #679
• Soret coefficient as a function of temperature by @KulaginVladimir in #690
• RaiseError when DirichletBC is set with another BC by @KulaginVladimir in #692
• max_stepsize attribute for festim.Stepsize by @KulaginVladimir in #698
• Warn about derived quantities in non cartesian by @RemDelaporteMathurin in #688

Bug fixes

• Fix bug with calculations on small timescales by @KulaginVladimir in #682
• Bug in test_unused_thermal_cond due to pytest update by @KulaginVladimir in #691

Documentation

• Updating getting_started link in README.md by @Allentro in #696
• Fix workshop link in documentation by @RemDelaporteMathurin in #678
• Improve docs by @RemDelaporteMathurin in #681
• Documentation: getting started to installation by @RemDelaporteMathurin in #687
• Small update of Docs by @KulaginVladimir in #699

Refactoring

• F.Materials -> subclass of list by @KulaginVladimir in #694
• F.Exports -> subclass of list by @KulaginVladimir in #695
• F.Traps and F.DerivedQuantities -> subclasses of list by @KulaginVladimir in #697

New Contributors

• @Allentro made their first contribution in #696

Full Changelog: v1.1.1...v1.2

Patch 1.1.1

What's Changed

• Fix bug is_steady_state with TemperatureFromXDMF by @RemDelaporteMathurin in #674

Full Changelog: v1.1...v1.1.1

Release 1.1

What's Changed

• Fix build documentation by @RemDelaporteMathurin in #630
• Updated Documentation by @Rajdeep1311 in #631
• Export data with TXTExport into single file by @KulaginVladimir in #628
• MeshFromVertices in parallel by @KulaginVladimir in #634
• Code of Conduct by @RemDelaporteMathurin in #649
• Fix README links by @RemDelaporteMathurin in #648
• Update README.md by @tadash10 in #651
• PointValue class by @KulaginVladimir in #655
• InitialCondition for HeatTransferProblem by @KulaginVladimir in #662
• Update Codecov upload step by @RemDelaporteMathurin in #667
• Update theory.rst by @KulaginVladimir in #664
• Fix TOC in Theory by @RemDelaporteMathurin in #670
• Update metadata of documentation by @RemDelaporteMathurin in #669

New Contributors

• @Rajdeep1311 made their first contribution in #631
• @KulaginVladimir made their first contribution in #628
• @tadash10 made their first contribution in #651

Full Changelog: v1.0...v1.1

Release 1.0

After several years of development, it is finally time to release 1.0! 🚀

What's Changed

New features

• Simulation time milestones by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/568
• Export to txt at all times and in steady state by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/555
• Dissociation flux by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/557

Fixes

• Fix parrallel hanging behaviour by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/571
• Error raised when invalid field for BC by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/550
• Fix final time overshoot by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/556
• Trap density xdmf fix by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/564
• Patch derived quantities not exported at final timestep when stepsize is small by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/567
• Linear solver for post-process chemical potential by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/579
• Fix tiny timestep bug by @gabriele-ferrero in https://github.com/RemDelaporteMathurin/FESTIM/pull/580
• Fix dissociation BC for festim by @gabriele-ferrero in https://github.com/RemDelaporteMathurin/FESTIM/pull/581

Documentation

• Mamba for docs compilation by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/548
• Update README conda package installation by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/545
• Smaller README by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/549
• added ImplantationFlux to docs by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/560
• Better api reference documentation by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/552
• Examples in documentations by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/554
• Remove demos from repo by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/558
• Fixed suggest edit in documentation by @gabriele-ferrero in https://github.com/RemDelaporteMathurin/FESTIM/pull/572
• Added Info on different version installation in the getting started file by @gabriele-ferrero in https://github.com/RemDelaporteMathurin/FESTIM/pull/574

Misc

• Use literal rather than "is not" by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/553
• fixed badge for circle by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/575
• Deprecations by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/578
• GithubActions instead of CircleCI by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/590
• Added parametric test for Flux BC initialise by @gabriele-ferrero in https://github.com/RemDelaporteMathurin/FESTIM/pull/588

New Contributors

• @gabriele-ferrero made their first contribution in https://github.com/RemDelaporteMathurin/FESTIM/pull/572

Full Changelog: RemDelaporteMathurin/FESTIM@v0.11.1...v1.0

Patch 0.11.1

What's Changed

• Formatting by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/543
• Fixing bug where stepsize is almost zero by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/542

Full Changelog: RemDelaporteMathurin/FESTIM@v0.11.0...v0.11.1

v0.11.0

What's Changed

• Adaptation of time display according to log level by @Lili-Gigi in https://github.com/RemDelaporteMathurin/FESTIM/pull/524
• Solver parameter options for extrinsic traps by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/525
• Regular merge to main by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/526
• moving to newer setuptools_scm by @shimwell in https://github.com/RemDelaporteMathurin/FESTIM/pull/527
• Feature mass transfer bc by @SamueleMeschini in https://github.com/RemDelaporteMathurin/FESTIM/pull/533
• NeutronInducedTrap fix - solver parameter assertion by @jhdark in https://github.com/RemDelaporteMathurin/FESTIM/pull/534
• Regular merge to main by @RemDelaporteMathurin in https://github.com/RemDelaporteMathurin/FESTIM/pull/535

New Contributors

• @Lili-Gigi made their first contribution in https://github.com/RemDelaporteMathurin/FESTIM/pull/524
• @SamueleMeschini made their first contribution in https://github.com/RemDelaporteMathurin/FESTIM/pull/533

Full Changelog: RemDelaporteMathurin/FESTIM@v0.10.3...v0.11.0