Skip to content

Commit

Permalink
updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RoccoDAnt committed Aug 7, 2023
1 parent 75367bb commit 2ff47b5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
12 changes: 8 additions & 4 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<a href="https://codecov.io/gh/RoccoDAnt/napari-zelda"><img src="https://codecov.io/gh/RoccoDAnt/napari-zelda/branch/master/graph/badge.svg" alt="codecov"></a></p>
<h2 id="zelda-a-3d-image-segmentation-and-parent-child-relation-plugin-for-microscopy-image-analysis-in-napari">ZELDA: a 3D Image Segmentation and Parent-Child relation plugin for microscopy image analysis in napari</h2>
<h4 id="authors-rocco-d-antuono-giuseppina-pisignano">Authors: Rocco D&apos;Antuono, Giuseppina Pisignano</h4>
<h6 id="preprint-https-www-biorxiv-org-content-10-1101-2021-10-24-465596v1">Preprint: <a href="https://www.biorxiv.org/content/10.1101/2021.10.24.465596v1">https://www.biorxiv.org/content/10.1101/2021.10.24.465596v1</a></h6>
<h6 id="article-front-comput-sci-04-january-2022-https-doi-org-10-3389-fcomp-2021-796117">Article: Front. Comput. Sci., 04 January 2022 | <a href="https://doi.org/10.3389/fcomp.2021.796117">https://doi.org/10.3389/fcomp.2021.796117</a></h6>
<h6 id="examples-of-2d-and-3d-data-sets-https-doi-org-10-5281-zenodo-5651284">Examples of 2D and 3D data sets: <a href="https://zenodo.org/record/5651284#.YYgn_WDP2Ch">https://doi.org/10.5281/zenodo.5651284</a></h6>
<hr>
<h2 id="what-you-can-do-with-zelda-plugin-for-napari">What you can do with ZELDA plugin for napari</h2>
Expand Down Expand Up @@ -97,10 +97,14 @@ <h2 id="installation">Installation</h2>
</ol>
<p><strong>Option B.</strong> You can install <code>napari-zelda</code> also via <a href="https://pypi.org/project/pip/">pip</a>. For the best experience, create a conda environment and use napari!=0.4.11, using the following instructions:</p>
<pre><code>conda create -y -n napari-env python==3.8
conda activate napari-env
pip install &quot;napari[all]&quot;
conda activate napari-env
conda install napari pyqt
pip install napari-zelda </code></pre><p><strong>Option C.</strong> Alternatively, clone the repository and install locally via <a href="https://pypi.org/project/pip/">pip</a>:</p>
<pre><code>pip install -e .</code></pre><h2 id="specifications">Specifications</h2>
<pre><code>pip install -e .</code></pre><p><strong>Option D.</strong> Get the latest code with <a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">git</a> and <a href="https://pypi.org/project/pip/">pip</a>:</p>
<pre><code>conda create -y -n napari-env python=3.8 git
conda activate napari-env
conda install napari pyqt
pip install git+https://github.com/RoccoDAnt/napari-zelda.git</code></pre><h2 id="specifications">Specifications</h2>
<p>This <a href="https://github.com/napari/napari">napari</a> plugin was generated with <a href="https://github.com/audreyr/cookiecutter">Cookiecutter</a> using with <a href="https://github.com/napari">@napari</a>&apos;s <a href="https://github.com/napari/cookiecutter-napari-plugin">cookiecutter-napari-plugin</a> template.</p>
<p>The GUI has been developed using <a href="https://github.com/napari/magicgui">magicgui</a> widgets, while the image analysis and processing include functions from <a href="https://scikit-image.org/">scikit-image</a>, <a href="https://scipy.org/">SciPy</a>, and <a href="https://numpy.org/">NumPy</a>. Results are handled with <a href="https://pandas.pydata.org/">pandas</a> and <a href="https://datatable.readthedocs.io/en/latest/">datatable</a>. Plots are obtained with <a href="https://matplotlib.org/">matplotlib</a>. </p>
<!--
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,22 @@ For small monitors it may be convenient to float the protocol panel
**Option B.** You can install `napari-zelda` also via [pip]. For the best experience, create a conda environment and use napari!=0.4.11, using the following instructions:

conda create -y -n napari-env python==3.8
conda activate napari-env
pip install "napari[all]"
conda activate napari-env
conda install napari pyqt
pip install napari-zelda


**Option C.** Alternatively, clone the repository and install locally via [pip]:

pip install -e .

**Option D.** Get the latest code with [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [pip]:

conda create -y -n napari-env python=3.8 git
conda activate napari-env
conda install napari pyqt
pip install git+https://github.com/RoccoDAnt/napari-zelda.git


## Specifications

Expand Down

0 comments on commit 2ff47b5

Please sign in to comment.