Commit d095d3d2 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

Package revision: arosics replaces the deprecated library CoReg_Sat. Revised package structure.

parent e61d7203
root = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf
indent_style = tab
end_of_line = crlf
insert_final_newline = false
indent_style = tab
* arosics version:
* Python version:
* Operating System:
### Description
Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.
### What I Did
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
# Created by .ignore support plugin (
# Byte-compiled / optimized / DLL files
# C extensions
# Distribution / packaging
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
# Installer logs
# Unit test / coverage reports
# Translations
# Django stuff:
# Sphinx documentation
# PyBuilder
# pyenv python configuration file
# PyCharm
# Config file for automatic testing at
# This file will be regenerated if you run
language: python
- 3.5
- 3.4
- 3.3
- 2.7
- 2.6
# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
install: pip install -U tox-travis
# command to run tests, e.g. python test
script: tox
# After you create the Github repo and add it to Travis, run the
# script to finish PyPI deployment setup
provider: pypi
distributions: sdist bdist_wheel
user: danschef
tags: true
repo: danschef/arosics
python: 2.7
Development Lead
* Daniel Scheffler <>
None yet. Why not be the first?
.. highlight:: shell
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
Report Bugs
Report bugs at
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
Fix Bugs
Look through the GitHub issues for bugs. Anything tagged with "bug"
and "help wanted" is open to whoever wants to implement it.
Implement Features
Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.
Write Documentation
arosics could always use more documentation, whether as part of the
official arosics docs, in docstrings, or even on the web in blog posts,
articles, and such.
Submit Feedback
The best way to send feedback is to file an issue at
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
Get Started!
Ready to contribute? Here's how to set up `arosics` for local development.
1. Fork the `arosics` repo on GitHub.
2. Clone your fork locally::
$ git clone
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
$ mkvirtualenv arosics
$ cd arosics/
$ python develop
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
$ flake8 arosics tests
$ python test or py.test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
and make sure that the tests pass for all supported Python versions.
To run a subset of tests::
$ python -m unittest tests.test_arosics
0.1.0 (2017-06-15)
* First release on PyPI.
Apache Software License 2.0
Copyright (c) 2017, Daniel Scheffler
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
recursive-include docs *.rst Makefile make.bat *.jpg *.png *.gif
.PHONY: clean clean-test clean-pyc clean-build docs help
import os, webbrowser, sys
from urllib import pathname2url
from urllib.request import pathname2url"file://" + pathname2url(os.path.abspath(sys.argv[1])))
import re, sys
for line in sys.stdin:
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
if match:
target, help = match.groups()
print("%-20s %s" % (target, help))
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +
clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
clean-test: ## remove test and coverage artifacts
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
lint: ## check style with flake8
flake8 arosics tests
test: ## run tests quickly with the default Python
python test
test-all: ## run tests on every Python version with tox
coverage: ## check code coverage quickly with the default Python
coverage run --source arosics test
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html
docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/arosics.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ arosics
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
release: clean ## package and upload a release
python sdist upload
python bdist_wheel upload
dist: clean ## builds source and wheel package
python sdist
python bdist_wheel
ls -l dist
install: clean ## install the package to the active Python's site-packages
python install
......@@ -349,7 +349,7 @@ CRL.view_CoRegPoints(figsize=(15,15),backgroundIm='ref')
The output figure shows the calculated absolute lenghts of the shift vectors - in this case with shifts up to ~25 meters.
......@@ -377,7 +377,7 @@ CRL_after_corr.view_CoRegPoints(figsize=(15,15),backgroundIm='ref')
The output figure shows a significant reduction of geometric shifts.
.. image::
.. image::
.. image::
:alt: Documentation Status
.. image::
:alt: Updates
An Automated and Robust Open-Source Image Co-Registration Software for Multi-Sensor Satellite Data
* Free software: Apache Software License 2.0
* Documentation:
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter:
.. _`audreyr/cookiecutter-pypackage`:
from .components.CoReg import COREG
from .components.CoReg_local import COREG_LOCAL
from .components.DeShifter import DESHIFTER
from .components.Tie_Point_Grid import Tie_Point_Grid
from .components import io
from .components import plotting
from .components import utilities
from .components import geometry
__author__ = 'Daniel Scheffler'
__version__= '2017-06-09_01'
......@@ -31,9 +31,9 @@ except ImportError:
# internal modules
from .DeShifter import DESHIFTER, _dict_rspAlg_rsp_Int
from . import geometry as GEO
from . import io as IO
from . import plotting as PLT
from . import geometry as GEO
from . import io as IO
from . import plotting as PLT
from geoarray import GeoArray
from py_tools_ds.convenience.object_oriented import alias_property
......@@ -21,8 +21,8 @@ from skimage.measure import points_in_poly, ransac
from skimage.transform import AffineTransform, PolynomialTransform
# internal modules
from .CoReg import COREG
from . import io as IO
from .CoReg import COREG
from . import io as IO
from py_tools_ds.geo.projection import isProjectedOrGeographic, get_UTMzone, dict_to_proj4, proj4_to_WKT
from import get_generic_outpath
from py_tools_ds.processing.progress_mon import ProgressBar
# -*- coding: utf-8 -*-
"""Top-level package for arosics."""
__author__ = """Daniel Scheffler"""
__email__ = ''
__version__ = '0.1.0'
__versionalias__ = '2017-06-15_01'
from .CoReg import COREG
from .CoReg_local import COREG_LOCAL
from .DeShifter import DESHIFTER
from .Tie_Point_Grid import Tie_Point_Grid
from . import io
from . import plotting
from . import utilities
from . import geometry
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment