v1.0.0

AMEP 1.0.0 Release Notes

This is the first public version of AMEP. It fully integrates the analysis of
continuum simulation data, fixes various bugs of version 0.5.0, and provides
useful new features. It is also the first version that is available from PyPI via pip.

AMEP 1.0.0 supports Python 3.10.0 or higher and requires the following Python libraries:

• h5py (3.7.0 or higher)
• matplotlib (3.6.2 or higher)
• numba (0.56.4 or higher)
• numpy (1.21.6 or higher)
• scipy (1.10.0 or higher)
• scikit-image (0.20.0 or higher)
• tqdm (4.65.0 or higher)

New features:

• gyration tensor and inertia tensor added to amep.continuum.cluster_properties (LH)
• new modes for amep.evaluate.ClusterGrowth (KS)
• amep.plot.draw_box with new text features (KD)
• new cluster detection method for continuum data (KS)
• pbc keyword now consitently available in all evaluate classes (LH)
• property time added to amep.base.BaseField (KS)
• physical time added to continuum data format (KS)
• parallelized calculation of distance matrix (ME, LH)

Bug fixes:

• traj.animate colorbar bug fixed (LH)
• loading trajectories bug when loading process interrupted fixed (LH, KD)
• bug in amep.statistics.distribution for large datasets fixed (ME)
• amep.evaluate.LDdist bug fixed related to keyword forwarding (KD)
• 2d data detection for constant z coordinates (KD)
• unclear error message in particle cluster method fixed (LH)
• incorrect normalization in amep.evaluate.OACF fixed (LH)
• bug in amep.evaluate.ClusterSizeDist related to negative density fields fixed (KS)
• incorrect return in amep.order.local_density fixed (LH)
• amep.plot.add_colorbar now returns the axis object (LH)
• bug in amep.spatialcor.spatialcor fixed related to incorrect calculation for pbc=True (LH)
• incorrect backup behavior in amep.base.BaseEvaluation.save fixed (LH)
• bug in amep.load.traj related to dots in path names fixed (LH, KD)
• bug in amep.order.next_neighbors fixed related to incorrect ids from the voronoi tesselation (KD)
• evaluation HDF5 data format unified (LH)
• cluster methods unified (AM)
• bug related to very slow cluster method fixed (LH)
• not working save method of amep.evaluate.HexOrderCor fixed (LH)
• incorrect directory return of amep.base.check_path fixed (LH)
• bug related to multiple warnings printed when loading continuum data fixed (LH)
• bug in amep.reader.ContinuumReader related to missing keywords nth, start, and stop fixed (LH)
• error for continuum data with reload=True in amep.load.traj fixed (LH)
• bug in amep.base.BaseFrame.data related to wildcard characters fixed (LH, KD)
• incorrect normalization in amep.cluster.sf2d fixed (AM)
• minor bugs in amep.plot.particles fixed (KD)
• bug in amep.order.voronoi_density related to QhullError fixed (KD)
• problem with repeated indices in amep.utils.average_func fixed (LH)
• missing integration limits in `amep.utils.domain_length´ added (LH)
• incorrect calculation of moments in amep.statistics.binder_cumulant fixed (LH, LW)
• bug in amep.pbc.kdtree related to an error occured when particles are exactly at the border of the simulation box fixed (LH)
• new plot styles are now installed when installing AMEP via pip (KS)
• amep.plot.format_axis improved (LH, ME)

Deprecation and removals:

• local_density in module order replaced by the three functions local_number_density, local_mass_density, and local_packing_fraction (LH)
• amep.plot.savefig removed (LH, KD)
• amep.cluster.cluster replaced by amep.cluster.identify (AM)
• amep.cluster.csf2d renamed to amep.cluster.sf2d (LH)
• all functions now take the box boundary as an input instead of the box length (LH)
• amep.continuum.cluster replaced by amep.continuum.identify_clusters and amep.continuum.cluster_properties (AM)

Contributors:

• Lukas Hecht (LH)
• Kay-Robert Dormann (KD)
• Kai Luca Spanheimer (KS)
• Mahdieh Ebrahimi (ME)
• Aritra Mukhopadhyay (AM)
• Lukas Walter (LW)