diff --git a/docs/assets/fractal_favicon.png b/docs/assets/fractal_favicon.png new file mode 100644 index 000000000..db2bbb486 Binary files /dev/null and b/docs/assets/fractal_favicon.png differ diff --git a/docs/assets/fractal_logo.png b/docs/assets/fractal_logo.png new file mode 100644 index 000000000..32a553170 Binary files /dev/null and b/docs/assets/fractal_logo.png differ diff --git a/docs/index.md b/docs/index.md index b053559bc..c5198f00f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. +

+ Fractal client +

-> 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. diff --git a/mkdocs.yml b/mkdocs.yml index 16c5fe8bb..dc9303274 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -39,6 +41,8 @@ theme: name: Switch to light mode icon: repo: fontawesome/brands/github + navigation: + expand: true nav: @@ -78,8 +82,7 @@ extra_css: - extra.css copyright: | - © Copyright 2022 - Friedrich Miescher Institute for Biomedical Research and + © Copyright 2024 University of Zurich (see LICENSE