Skip to content

Commit

Permalink
Outlines of README and contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
cmalinmayor committed Feb 14, 2024
1 parent 001bff4 commit d6413f7
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTOR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributor Guide

## Development Installation
- currently, pip install -r requirements-dev.txt
and then pip install -e .
TODO: set up pip install -e .[dev]

## Style and Pre-Commit
- TODO: pre-commit with black mypy
- do use ruff and black
- do have typing, developers should supply types

## Testing
- Unittest your functions
- Pytest run automatically on PR, and so is codcov (maybe)
TODO: codecov


## Branching and PRs
- Users that have been added to the CellMap organization and the DaCapo project should be able to develop directly into the CellMap fork of DaCapo. Other users will need to create a fork.
- For a completely new feature, make a branch off of the `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 main branch of CellMap's fork, or the feature branch you branched off of. Once the PR is merged, the feature branch should be deleted.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,25 @@ on arbitrarily large volumes of
multi-dimensional images. `dacapo` is not tied to a particular learning
framework, but currently only supports [`torch`](https://pytorch.org/) with
plans to support [`tensorflow`](https://www.tensorflow.org/).

## Installation and Setup
Currently, only python 3.10 is supported. We recommend creating a new conda environment for dacapo with python 3.10.
```
conda create -n dacapo python=3.10
```

Then clone this repository, go into the directory, and install:
```
git clone git@github.com:janelia-cellmap/dacapo.git
cd dacapo
pip install .
```
This will install the minimum required dependencies. However, having acess to a MongoDB server for storing outputs is strongly recommended for smoothest performance.

To install and run MongoDB locally, refer to the MongoDB documentation [here](https://www.mongodb.com/docs/manual/installation/).

## Functionality Overview

Tasks we support

Networks we have for those tasks

0 comments on commit d6413f7

Please sign in to comment.