Skip to content

Commit

Permalink
updated README and classification
Browse files Browse the repository at this point in the history
  • Loading branch information
glichtner committed Dec 9, 2020
1 parent 81e4aa8 commit e8dd508
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 3 deletions.
24 changes: 24 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF
formats:
- pdf

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: requirements.txt
38 changes: 37 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
pyStackReg
==========

.. start-badges
.. image:: https://ci.appveyor.com/api/projects/status/3kqq8qyc9b7o1coe?svg=true
:target: https://ci.appveyor.com/api/projects/status/3kqq8qyc9b7o1coe?svg=true
:alt: Build status

.. image:: https://readthedocs.org/projects/pystackreg/badge/?version=latest
:target: https://pystackreg.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://badge.fury.io/py/pystackreg.svg
:alt: PyPI Package latest release
:target: https://pypi.org/project/pystackreg

.. image:: https://img.shields.io/pypi/pyversions/pystackreg.svg
:alt: Supported Python Versions
:target: https://pypi.org/project/pystackreg/

.. image:: https://pepy.tech/badge/pystackreg
:alt: Downloads
:target: https://pepy.tech/project/pystackreg/

.. end-badges
Summary
-------
Python/C++ port of the ImageJ extension TurboReg/StackReg written by Philippe Thevenaz/EPFL.
Expand All @@ -26,7 +54,15 @@ Please note: The bilinear transformation cannot be propagated, as a combination

Installation
------------
The package is available on PyPi. Install it using:
The package is available on conda forge and on PyPi.

- Install using **conda**

.. code-block:: python
conda install pystackreg -c conda-forge
- Install using **pip**

.. code-block:: python
Expand Down
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
16 changes: 15 additions & 1 deletion docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
</div>
<div class="section" id="pystackreg">
<h1>pyStackReg<a class="headerlink" href="#pystackreg" title="Permalink to this headline"></a></h1>
<a class="reference external image-reference" href="https://ci.appveyor.com/api/projects/status/3kqq8qyc9b7o1coe?svg=true"><img alt="Build status" src="https://ci.appveyor.com/api/projects/status/3kqq8qyc9b7o1coe?svg=true" /></a>
<a class="reference external image-reference" href="https://pystackreg.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/pystackreg/badge/?version=latest" /></a>
<a class="reference external image-reference" href="https://pypi.org/project/pystackreg"><img alt="PyPI Package latest release" src="https://badge.fury.io/py/pystackreg.svg" /></a>
<a class="reference external image-reference" href="https://pypi.org/project/pystackreg/"><img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/pystackreg.svg" /></a>
<a class="reference external image-reference" href="https://pepy.tech/project/pystackreg/"><img alt="Downloads" src="https://pepy.tech/badge/pystackreg" /></a>
<div class="section" id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline"></a></h2>
<p>Python/C++ port of the ImageJ extension TurboReg/StackReg written by Philippe Thevenaz/EPFL.</p>
Expand All @@ -75,7 +80,16 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>The package is available on PyPi. Install it using:</p>
<p>The package is available on conda forge and on PyPi.</p>
<ul class="simple">
<li><p>Install using <strong>conda</strong></p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">pystackreg</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Install using <strong>pip</strong></p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pystackreg</span>
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,23 @@ def read(fname):
],
include_dirs=["inc/"] + numpy.distutils.misc_util.get_numpy_include_dirs(),
install_requires=["numpy", "tqdm"],
classifiers=[
# complete list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Science/Research",
"License :: Free To Use But Restricted",
"Operating System :: Microsoft :: Windows",
"Operating System :: Unix",
"Operating System :: POSIX",
"Programming Language :: C++",
"Programming Language :: Python",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Topic :: Scientific/Engineering :: Image Processing",
"Topic :: Utilities",
],
)

0 comments on commit e8dd508

Please sign in to comment.