Skip to content
Snippets Groups Projects
index.md 1.19 KiB
Newer Older
  • Learn to ignore specific revisions
  • fima's avatar
    fima committed
    # ![qim3d logo](assets/qim3d-logo.svg){ width="256" }
    
    
    `qim3d` is a Python library for quantitative imaging analysis in 3D. It provides functionality for handling data, as well as tools for visualization and analysis.
    
    
    fima's avatar
    fima committed
    ![Data explorer GUI](assets/screenshots/qim3d-filters_example.png)
    
    
    ## Installation
    
    
    fima's avatar
    fima committed
    Creating an `conda` environment is not required but recommended:
    
    fima's avatar
    fima committed
    conda create -n qim3d python=3.11
    
    fima's avatar
    fima committed
    After the environment is created, activate it by running:
    ```
    conda activate qim3d
    
    fima's avatar
    fima committed
    Install the latest stable version by using `pip`:
    
    fima's avatar
    fima committed
    pip install qim3d
    ```
    !!! warning
        Installing `qim3d` may take a bit of time due to its dependencies. Thank you for your patience!
    
    fima's avatar
    fima committed
    ## Contributing
    Contributions to `qim3d` are welcome! 
    
    fima's avatar
    fima committed
    If you find a bug, have a feature request, or would like to contribute code, please open an issue or submit a pull request.
    
    fima's avatar
    fima committed
    You can find us at Gitlab:
    [https://lab.compute.dtu.dk/QIM/tools/qim3d](https://lab.compute.dtu.dk/QIM/tools/qim3d
    )
    
    fima's avatar
    fima committed
    This project is licensed under the MIT License.
    
    fima's avatar
    fima committed
    ## Support
    
    The development of `qim3d` is supported by:
    
    fima's avatar
    fima committed
    ![Novo Nordisk Foundation](https://novonordiskfonden.dk//app/uploads/NNF-INT_logo_tagline_blue_RGB_solid.png){ width="256" }