dockerfile

CONTRIBUTING.md

@@ -26,3 +26,11 @@ This will also be run automatically when a PR is made to master and a codecov re
 - For a completely new feature, make a branch off of the `dev/main` branch of CellMap's fork of DaCapo with a name describing the feature. If you are collaborating on a feature that already has a branch, you can branch off that feature branch.
 - Currently, you should make your PRs into the `dev/main` branch of CellMap's fork, or the feature branch you branched off of. PRs currently require one maintainer's approval before merging. Once the PR is merged, the feature branch should be deleted. 
 - `dev/main` will be regularly merged to `main` when new features are fully implemented and all tests are passing.
+
+
+## Documentation
+Documentation is built using Sphinx. To build the documentation locally, run
+```bash
+sphinx-build -M html docs/source docs/build
+```
+This will generate the html files in the `docs/build/html` directory.

dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y \
+    gcc \
+    g++ \
+    pkg-config \
+    make \
+    libhdf5-dev \
+    libc-dev \
+    npm \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN npm install -g configurable-http-proxy
+
+RUN pip install --upgrade pip
+
+RUN pip install h5py
+RUN pip install dacapo-ml
+RUN pip install notebook
+
+RUN git clone https://github.com/janelia-cellmap/dacapo.git
+RUN mv dacapo/examples examples && rm -rf dacapo
+
+EXPOSE 8000
+
+CMD ["jupyter", "notebook", "--ip=0.0.0.0", "--port=8000", "--NotebookApp.allow_origin='*'", "--allow-root", "--NotebookApp.token=''", "--NotebookApp.password=''", "--NotebookApp.notebook_dir='/app/'"]
+

docs/source/docker.rst

@@ -0,0 +1,48 @@
+.. automodule:: dacapo
+
+.. contents::
+  :depth: 1
+  :local:
+
+Docker Configuration for JupyterHub-Dacapo
+=========================================
+
+This document provides instructions on how to build and run the Docker image for the JupyterHub-Dacapo project.
+
+Requirements
+------------
+Before you begin, ensure you have Docker installed on your system. You can download it from `Docker's official website <https://docker.com>`_.
+
+Building the Docker Image
+-------------------------
+To build the Docker image, navigate to the directory containing your Dockerfile and run the following command:
+
+.. code-block:: bash
+
+    docker build -t jupyterhub-dacapo .
+
+This command builds a Docker image with the tag `jupyterhub-dacapo` using the Dockerfile in the current directory.
+
+Running the Docker Container
+----------------------------
+Once the image is built, you can run a container from the image with the following command:
+
+.. code-block:: bash
+
+    docker run -p 8000:8000 jupyterhub-dacapo
+
+This command starts a container based on the `jupyterhub-dacapo` image. It maps port 8000 of the container to port 8000 on the host, allowing you to access JupyterHub by navigating to `http://localhost:8000` in your web browser.
+
+Stopping the Docker Container
+-----------------------------
+To stop the running container, you can use the Docker CLI to stop the container:
+
+.. code-block:: bash
+
+    docker stop [CONTAINER_ID]
+
+Replace `[CONTAINER_ID]` with the actual ID of your running container. You can find the container ID by listing all running containers with `docker ps`.
+
+Further Configuration
+---------------------
+For additional configuration options, such as setting environment variables or configuring volumes, refer to the Docker documentation or the specific documentation for the JupyterHub or Dacapo configurations.

docs/source/index.rst

@@ -10,6 +10,7 @@
    overview
    install
    tutorial
+   docker
    autoapi/index
    cli