Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improving documentation #7

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
4 changes: 3 additions & 1 deletion 1.chunkedgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ and link the image and tag in `values.yaml` (refer to `example_values.yaml`).

> NOTE: Depending on your dataset, you will need to figure out the optimal limits for cpu and memory in your worker deployments. To do that adjust the `count` and `machine` variables in terraform.tfvars. It can vary with chunk size, size of supervoxels (atomic semgents in layer 1), number of edges per chunk and so on.

> NOTE: The bucket storing the edges, components etc must be public. The bucket is also linked in `example_values.yaml` [here](https://github.com/seung-lab/CAVEpipelines/blob/4d0ee8d98fb8891074d6e1115ed9394e6a021cd5/helm/pychunkedgraph/example_values.yaml#L29).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bucket with segmentation data needs to be public, not the one with edges and components. They do not need to be in the same bucket. It needs to be public for neuroglancer to read.


#### Chart Installation
When all variables are ready, rename your values file to `values.yaml` (ignored by git because it can contain sensitive information). Then run:

Expand All @@ -83,7 +85,7 @@ Pods should now be in `Running` status, provided there were no issues. Run the f
```shell
$ kubectl exec -ti deploy/master -- bash
// now you're in the container
> ingest graph <unique_test_bigtable_name> datasets/test.yml --test
> ingest graph <unique_test_bigtable_name> datasets/test.yml --test // avoid dashes in <unique_test_bigtable_name>, neuroglancer can't handle them
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be cave code that has issues with dashes. It is better to just say use underscores instead.

```

[RQ](https://python-rq.org/docs/) is used to create jobs. This library uses `redis` as a task queue.
Expand Down