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

Update README with synth data + env options #156

Merged
merged 4 commits into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 15 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,34 @@ The `grace` workflow consists of the following steps:

`grace` has been tested with Python 3.8+ on OS X.

For local development, clone the repo and install in editable mode:
For local development, clone the repo and install in editable mode following these guidelines:

*Note:* Choose which conda environment you'd like to use:
* If you need to annotate your data (images) in *napari*, we recommend the `grace-env-with-napari` -> `environment-with-napari.yaml`
* If you rely on previously annotated data and do not require *napari*, we recommend the `grace-env-napari-free` -> `environment-napari-free.yaml`
KristinaUlicna marked this conversation as resolved.
Show resolved Hide resolved

Specify your preference & follow the steps below:

```sh
# clone the grace GitHub repository

git clone https://github.com/alan-turing-institute/grace.git
cd ./grace

# create a conda playground from environment.yaml
conda env create -f environment.yaml

# create a conda playground from the respective environment.yaml
conda env create -f YOUR-CHOSEN-ENVIRONMENT.yaml

# To activate this environment, use
#
# $ conda activate grace-environment
# $ conda activate grace-env-with-napari
# OR
# $ conda activate grace-env-napari-free
#
# To deactivate an active environment, use
#
# $ conda deactivate

conda activate grace-environment
conda activate grace-env-OF-YOUR-CHOICE

# install grace from local folder (not on pypi yet)

Expand All @@ -92,27 +99,10 @@ conda install -c conda-forge pre_commit
pre-commit install

```

The above environment allows GRACE to be run on previously annotated images (saved on .grace format). If, however, annotation is needed, use the following lines to load and activate the correct environment, which will install further packages (such as napari):

```sh
# create the playground from environment_annotation.yml
conda env create -f environment_annotation.yaml

# To activate this environment, use
#
# $ conda activate grace-annotation
#
# To deactivate an active environment, use
#
# $ conda deactivate

conda activate grace-annotation

```

---

If you currently do not have any data to test / implement GRACE on, have a look at the option of **simulating a synthetic dataset** as described in [this](./grace/simulator/README.md) README. An accessible link to some pre-annotated simulated images is coming soon! 🚧


## Annotator GUI

Expand Down
2 changes: 1 addition & 1 deletion environment.yaml → environment-napari-free.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: grace_env
name: grace-env-napari-free
channels:
- conda-forge
- defaults
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: grace-annotation
name: grace-env-with-napari
channels:
- conda-forge
- defaults
Expand Down