Add pixi support for multiple platforms

.gitattributes

@@ -0,0 +1,4 @@
+# GitHub syntax highlighting
+pixi.lock linguist-language=YAML linguist-generated=true
+# SCM syntax highlighting
+pixi.lock linguist-language=YAML linguist-generated=true

.gitignore

@@ -185,8 +185,13 @@ tensorboard/
 # Challenge specific files
 data/*
 datasplit.csv
+result.csv
 result.json
 result_submitted_only.json
 
 # Bash tasks
-nohup.out
+nohup.out
+
+# pixi environments
+.pixi
+*.egg-info

README.md

@@ -15,7 +15,59 @@ The package is built on top of the [`cellmap-data`](https://github.com/janelia-c
 
 # Getting started
 
-## Set up your environment
+We provide two options for installation of the CellMap Segmentation Challenge software.
+1. Using `pixi`
+2. Using `micromamba` and `pip`
+
+`pixi` is a new package management tool that can handle both conda and PyPI packages. This is particularly useful installation on Windows or advanced setups.
+
+For basic usage, we also provide a `pip` based installation method using micromamba to create a virtual environment.
+You can also [use pyvenv to create a virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-a-new-virtual-environment).
+
+## Getting Started with Pixi
+
+First, install `pixi` by visiting [pixi.sh](https://pixi.sh/latest/#installation) or using the instructions below.
+
+### Linux & macOS
+
+```bash
+curl -fsSL https://pixi.sh/install.sh | bash
+```
+
+### Windows
+
+#### Powershell
+```
+iwr -useb https://pixi.sh/install.ps1 | iex
+```
+
+#### winget
+
+```
+winget install prefix-dev.pixi
+```
+
+### Clone the repository
+
+You can clone and install the repository by running the following command:
+
+```bash
+# Clone the repository
+git clone https://github.com/janelia-cellmap/cellmap-segmentation-challenge
+
+# Install the repo in editable mode
+cd cellmap-segmentation-challenge
+pixi install
+```
+
+### Using the pixi environment
+
+To use the pixi environment, you can either prefix the commands below with `pixi run` (e.g. `pixi run csc --fetch-data`),
+or use `pixi shell` which is similar to activating an environment with `conda` or `mamba`.
+
+## Getting started with micromamba and pip
+
+### Set up your environment
 
 We recommend using micromamba to create a new environment with the required dependencies. You can install micromamba by following the instructions [here](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html#automatic-install). The fastest way to do this install, if you are using Linux, macOS, or Git Bash on Windows, is to run the following in your terminal:
 
@@ -39,7 +91,7 @@ micromamba create -n csc -c conda-forge -y python==3.11
 micromamba activate csc
 ```
 
-## Clone the repository
+### Clone the repository
 
 You can clone and install the repository by running the following command: