Skip to content
Snippets Groups Projects
releases.md 6.25 KiB
Newer Older
  • Learn to ignore specific revisions
  • fima's avatar
    fima committed
    ---
    hide:
      - navigation
      
    ---
    
    
    fima's avatar
    fima committed
    # Release History
    
    fima's avatar
    fima committed
    [![PyPI version](https://badge.fury.io/py/qim3d.svg)](https://badge.fury.io/py/qim3d)
    [![Downloads](https://static.pepy.tech/badge/qim3d)](https://pepy.tech/project/qim3d)
    
    
    fima's avatar
    fima committed
    Below, you'll find details about the version history of `qim3d`.
    
    fima's avatar
    fima committed
    As the library is still in its early development stages, **there may be breaking changes** before `v1.0` without prior deprecation warnings. Therefore, it's advisable to review the release history for more information if you encounter any issues.
    
    
    s214735's avatar
    s214735 committed
    And remember to keep your pip installation [up to date](index.md/#get-the-latest-version) so that you have the latest features!
    
    fima's avatar
    fima committed
    ### v0.4.5 (21/11/2024)
    
    - Updated Layer surface segmentation GUI
    - Sphericity as feature from volumes
    - Colorbar for visualization functions
    - Chunk visualization tool
    - Histogram visualization
    
    
    fima's avatar
    fima committed
    ### v0.4.4 (11/10/2024)
    
    
    fima's avatar
    fima committed
    - Introduction of `itk-vtk-viewer` for OME-Zarr data visualization 🎉 ![itk-vtk-viewer](../../assets/screenshots/itk-vtk-viewer.gif)
    
    fima's avatar
    fima committed
    
    
    
    fima's avatar
    fima committed
    ### v0.4.3 (02/10/2024)
    
    - Updated requirements
    
    fima's avatar
    fima committed
    - Introduction of mesh generation, visualization, saving and loading 🎉  ![Mesh generation](../../assets/screenshots/releases/mesh_generation.png)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    ### v0.4.2 (30/09/2024)
    
    - Export and import is now possible in the OME-Zarr standard, including multi-scale datasets.
    
    fima's avatar
    fima committed
    - Filters now have the option to use Dask when available ![Filters with dask](../../assets/screenshots/releases/filters_with_dask.png)
    
    ### v0.4.1 (30/07/2024)
    
    - Fixed issue with example volumes not being loaded
    
    fima's avatar
    fima committed
    ### v0.4.0 (29/07/2024)
    
    - Refactored imports to use lazy loading
    - Namespace `utils` reserved for internal tools only
    - All deep-learning related functions moved to `models`
    - Running `pip install qim3d` does not install DL requirements. For those, use `pip install qim3d['deep-learning']` 
    
    
    
    fima's avatar
    fima committed
    ### v0.3.9 (24/07/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Loading and saving for Zarr files
    - File convertion using the CLI, including Zarr
    - Refactoring for the GUIs
    
    fima's avatar
    fima committed
    - Color visualization for structure tensor ![Color visualization for structure tensor](../../assets/screenshots/releases/qim3d-structure_tensor_with_colors.gif)
    
    fima's avatar
    fima committed
    - Refactoring for synthetic data generation, from `utils` to `generate`
    
    fima's avatar
    fima committed
    - Introduction of `qim3d.generate.collection` 🎉 ![Introduction of `qim3d.generate.collection`](../../assets/screenshots/releases/qim3d-generate_collection.gif)
    
    fima's avatar
    fima committed
    ### v0.3.8 (20/06/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Minor refactoring and bug fixes
    
    
    fima's avatar
    fima committed
    ### v0.3.7 (17/06/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Performance improvements when importing 
    
    fima's avatar
    fima committed
    - Refactoring for blob detection ![Refactoring for blob detection](../../assets/screenshots/releases/qim3d-blob_detection_refactoring.gif)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    ### v0.3.6 (30/05/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Refactoring for performance improvement
    - Welcome message for the CLI
    
    fima's avatar
    fima committed
    - Introduction of `qim3d.processing.fade_mask` 🎉 ![Introduction of `qim3d.processing.fade_mask`](../../assets/screenshots/releases/qim3d-fade_viz.gif)
    
    fima's avatar
    fima committed
    
    
    
    fima's avatar
    fima committed
    ### v0.3.5 (27/05/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Added runtime and memory usage in the documentation
    
    fima's avatar
    fima committed
    - Introduction of `qim3d.utils.generate_volume` 🎉 ![Introduction of `qim3d.utils.generate_volume`](../../assets/screenshots/releases/qim3d-synthetic_volume.gif)
    - CLI refactoring, adding welcome message to the user ![CLI refactoring](../../assets/screenshots/releases/qim3d-CLI_welcome_message.png)
    
    fima's avatar
    fima committed
    - Introduction of `preview` CLI 🎉
    
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    ### v0.3.4 (22/05/2024)
    
    fima's avatar
    fima committed
    
    
    s204159's avatar
    s204159 committed
    - Documentation for `qim3d.viz.plot_cc`
    
    fima's avatar
    fima committed
    - Fixed issue with Annotation tool and recent Gradio versions
    
    fima's avatar
    fima committed
    - New colormap: `qim3d.viz.colormaps.qim`, showcasing the Qim colors!
    
    - Object separation using `qim3d.processing.operations.watershed`
    
    s204159's avatar
    s204159 committed
    - Added option to pass `dim_order` to `vol/vgi` files
    
    fima's avatar
    fima committed
    - The 'Data Explorer' GUI now can load image sequences also
    
    fima's avatar
    fima committed
    - Warning in case user tries to load a file larger than available memory
    
    - Objects colormap now can enforce a `min_dist` between neighbor colors
    
    fima's avatar
    fima committed
    - It is possible to load a directory with a sequence of PIL images
    - Aspect ratio issue for k3d fixed
    
    s204159's avatar
    s204159 committed
    
    
    fima's avatar
    fima committed
    ### v0.3.3 (11/04/2024)
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
    - Introduction of `qim3d.viz.slicer` (and also `qim3d.viz.orthogonal` ) 🎉
    - Introduction of `qim3d.gui.annotation_tool` 🎉
    
    - Introduction of `qim3d.processing.Blob` for blob detection 🎉
    - Introduction of `qim3d.processing.local_thickness` 🎉
    - Introduction of `qim3d.processing.structure_tensor` 🎉
    
    s204159's avatar
    s204159 committed
    - Support for loading DICOM files with `qim3d.io.load`
    
    - Introduction of `qim3d.processing.get_3d_cc` for 3D connected components and `qim3d.viz.plot_cc` for associated visualization 🎉
    - Introduction of `qim3d.viz.colormaps` for easy visualization of e.g. multi-label segmentation results 🎉
    
    s204159's avatar
    s204159 committed
    - Introduction of `qim3d.processing.operations.background_removal` 🎉
    
    s204159's avatar
    s204159 committed
    - Documentation refactoring
    - Fixed bug preventing `Data Explorer` to show files
    
    fima's avatar
    fima committed
    ### v0.3.2 (23/02/2024)
    
    fima's avatar
    fima committed
    This version focus on the increased usability of the `qim3d` library
    
    fima's avatar
    fima committed
    - Online documentation available at [https://platform.qim.dk/qim3d](https://platform.qim.dk/qim3d)
    - Virtual stacks also available for `txm` files
    - Updated GUI launch pipeline
    
    fima's avatar
    fima committed
    - New functionalities for `qim3d.viz.slices_grid`
    
    fima's avatar
    fima committed
    - Introduction of `qim3d.processing.filters` 🎉 
    
    - Introduction of `qim3d.viz.vol` 🎉 
    
    fima's avatar
    fima committed
    ### v0.3.1 (01/02/2024)
    
    fima's avatar
    fima committed
    Release expanding the IO functionalities
    
    fima's avatar
    fima committed
    - Support for loading `vol` `nii` and `bigtiff` files
    - Data loader now supports `virtual_stack`
    - Save functionality for all file formats except `txm`
    
    fima's avatar
    fima committed
    ### v0.3.0 (23/01/2024)
    - Introduction of qim3d CLI 🎉 
    - Introduction of memory utils 🎉 
    - Data Explorer GUI
    - Save functionality for `tif` files
    
    fima's avatar
    fima committed
    ### v0.2.0 (18/09/2023)
    
    
    Includes new develoments toward the usability of the library, as well as its integration with the QIM platform.
    
    - Refactored code for the graphical interfaces
        - For the local thicknes GUI, now it is possible to pass and receive numpy arrays instead of using the upload functionality.
    - Improved data loader
        - Now the extensions `tif`, `h5` and `txm` are supported.
    
    fima's avatar
    fima committed
    - Added `qim3d.viz.slices_grid` for easy slice visualization.
    
    - U-net model creation
        - Model availabe from `qim3d.models.UNet`
        - Data augmentation class at `qim3d.utils.Augmentation`
        - Notebook with full pipeline at `docs/notebooks/Unet.ipynb`
    - Image examples accessible from `qim3d.examples`
    
    
    
    fima's avatar
    fima committed
    ### v0.1.3 (17/05/2023)
    
    
    First stable release.
    
    - Simple Tiff data loader
    - Graphical interfaces
        - Local thickness
        - 3D Isosurfaces
        - Data exploration tool