Skip to content

Commit

Permalink
[update] update README and env files
Browse files Browse the repository at this point in the history
  • Loading branch information
marta-seq committed May 19, 2024
1 parent f9619f7 commit 1890fbe
Show file tree
Hide file tree
Showing 2 changed files with 393 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ specifically for multiplex imaging data.

General view:
![plot](figs/main_figure.png)
image made with image2go


## Table of Contents
- [Clone the Repository](#clone-the-repository)
- [Requirements](#requirements)
- [Requirements/Installation](#requirements)
- [Getting started](#getting-started)
- [Credits](#credits)
- [License](#license)
Expand All @@ -46,19 +46,33 @@ git clone https://github.com/your_username/your_repository.git

## Create conda environment

Download the package and create environment or check requirements
You can create the environment installing the packages or using the ymal file.

To manually create and install packages use:

```bash
conda create --name penguin
conda activate penguin
conda install matplotlib pandas panel numpy opencv scikit-image ipywidgets jupyter ipykernel plotly
pip install apeer-ometiff-library --no-deps
```

if trouble with appeear-ome ti... and imagecodecs install no deps
Alternatively, you can create the environemtn using the yml file:

```bash
conda env create --file penguin_env.yml
conda activate penguin
pip install apeer-ometiff-library --no-deps
```

After you created the environment, and if you want to use the Jupyter notebooks

activate penguin environment and add the environment kernel to jupyter
add the environment kernel to jupyter
~~~~~~~~~~~~~
~~~~~~~~~~~~~
```bash
python -m ipykernel install --user --name=penguin
```

launch the jupyter and be sure that you are running with the penguin kernel

## Getting started
Expand Down
Loading

0 comments on commit 1890fbe

Please sign in to comment.