Skip to content

Commit

Permalink
Update mkdocs page with logo
Browse files Browse the repository at this point in the history
  • Loading branch information
jluethi committed Oct 30, 2024
1 parent d04a011 commit a34d0c9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 7 deletions.
Binary file added docs/assets/fractal_favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/fractal_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 11 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ hide:

# Welcome to Fractal Command-line Client's documentation!

Fractal is a framework to process high content imaging data at scale and prepare it for interactive visualization.
<p align="center">
<img src="https://github.com/user-attachments/assets/e8aef41e-b177-4f34-8681-8a5e756d6e38" alt="Fractal client" width="400">
</p>

> This project is under active development 🔨. If you need help or found a bug, **open an issue [here](https://github.com/fractal-analytics-platform/fractal/issues/new)**.
Fractal is a framework developed at the [BioVisionCenter](https://www.biovisioncenter.uzh.ch/en.html) to process bioimaging data at scale in the OME-Zarr format and prepare the images for interactive visualization.

Fractal provides distributed workflows that convert TBs of image data into [OME-Zar](https://ngff.openmicroscopy.org) files.
The platform then processes the 3D image data by applying tasks like illumination correction, maximum intensity projection, 3D segmentation using [cellpose](https://cellpose.readthedocs.io) and measurements using [napari workflows](https://github.com/haesleinhuepf/napari-workflows).
The pyramidal OME-Zarr files enable interactive visualization in the napari viewer.
> This project is under active development 🔨. If you need help or found a bug, **open an issue [here](https://github.com/fractal-analytics-platform/fractal/issues/new)**.
This documentation concerns the **Fractal Command-line Client**. Find more information about Fractal in general and the other repositories at the [Fractal home page](https://fractal-analytics-platform.github.io).

## Licence and Copyright

Fractal was conceived in the Liberali Lab at the Friedrich Miescher Institute for Biomedical Research and in the Pelkmans Lab at the University of Zurich by [@jluethi](https://github.com/jluethi) and [@gusqgm](https://github.com/gusqgm). The Fractal project is now developed at the [BioVisionCenter](https://www.biovisioncenter.uzh.ch/en.html) at the University of Zurich and the project lead is with [@jluethi](https://github.com/jluethi). The core development is done under contract by [eXact lab S.r.l.](https://www.exact-lab.it).

Unless otherwise specified, Fractal components are released under the BSD 3-Clause License, and copyright is with the BioVisionCenter at the University of Zurich.
7 changes: 5 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ markdown_extensions:

theme:
name: "material"
logo: 'assets/fractal_logo.png'
favicon: 'assets/fractal_favicon.png'
custom_dir: "docs/overrides"
features:
- content.code.annotate
Expand All @@ -39,6 +41,8 @@ theme:
name: Switch to light mode
icon:
repo: fontawesome/brands/github
navigation:
expand: true


nav:
Expand Down Expand Up @@ -78,8 +82,7 @@ extra_css:
- extra.css

copyright: |
© Copyright 2022
Friedrich Miescher Institute for Biomedical Research and
© Copyright 2024
University of Zurich
(see <u><a href="https://github.com/fractal-analytics-platform/fractal/blob/main/LICENSE">
LICENSE
Expand Down

0 comments on commit a34d0c9

Please sign in to comment.