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
# http://editorconfig.org
root = true
[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf
[*.bat]
indent_style = tab
end_of_line = crlf
[LICENSE]
insert_final_newline = false
[Makefile]
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 (hsz.mobi) # Byte-compiled / optimized / DLL files
.idea/ __pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# 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.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# pyenv python configuration file
.python-version
# PyCharm
.idea
# Config file for automatic testing at travis-ci.org
# This file will be regenerated if you run travis_pypi_setup.py
language: python
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 setup.py test
script: tox
# After you create the Github repo and add it to Travis, run the
# travis_pypi_setup.py script to finish PyPI deployment setup
deploy:
provider: pypi
distributions: sdist bdist_wheel
user: danschef
password:
secure: PLEASE_REPLACE_ME
on:
tags: true
repo: danschef/arosics
python: 2.7
=======
Credits
=======
Development Lead
----------------
* Daniel Scheffler <daniel.scheffler@gfz-potsdam.de>
Contributors
------------
None yet. Why not be the first?
.. highlight:: shell
============
Contributing
============
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 https://github.com/danschef/arosics/issues.
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 https://github.com/danschef/arosics/issues.
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 git@github.com:your_name_here/arosics.git
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 setup.py 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 setup.py 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
https://travis-ci.org/danschef/arosics/pull_requests
and make sure that the tests pass for all supported Python versions.
Tips
----
To run a subset of tests::
$ python -m unittest tests.test_arosics
=======
History
=======
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
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
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 conf.py Makefile make.bat *.jpg *.png *.gif
.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
define PRINT_HELP_PYSCRIPT
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))
endef
export PRINT_HELP_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
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 setup.py test
test-all: ## run tests on every Python version with tox
tox
coverage: ## check code coverage quickly with the default Python
coverage run --source arosics setup.py 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 setup.py sdist upload
python setup.py bdist_wheel upload
dist: clean ## builds source and wheel package
python setup.py sdist
python setup.py bdist_wheel
ls -l dist
install: clean ## install the package to the active Python's site-packages
python setup.py install
...@@ -349,7 +349,7 @@ CRL.view_CoRegPoints(figsize=(15,15),backgroundIm='ref') ...@@ -349,7 +349,7 @@ CRL.view_CoRegPoints(figsize=(15,15),backgroundIm='ref')
![png](output_40_1.png) ![png](docs/images/output_40_1.png)
The output figure shows the calculated absolute lenghts of the shift vectors - in this case with shifts up to ~25 meters. 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') ...@@ -377,7 +377,7 @@ CRL_after_corr.view_CoRegPoints(figsize=(15,15),backgroundIm='ref')
![png](output_44_1.png) ![png](docs/images/output_44_1.png)
The output figure shows a significant reduction of geometric shifts. The output figure shows a significant reduction of geometric shifts.
......
=======
arosics
=======
.. image:: https://img.shields.io/pypi/v/arosics.svg
:target: https://pypi.python.org/pypi/arosics
.. image:: https://img.shields.io/travis/danschef/arosics.svg
:target: https://travis-ci.org/danschef/arosics
.. image:: https://readthedocs.org/projects/arosics/badge/?version=latest
:target: https://arosics.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/danschef/arosics/shield.svg
:target: https://pyup.io/repos/github/danschef/arosics/
: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: https://arosics.readthedocs.io.
Features
--------
* TODO
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/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'
__all__=['COREG',
'COREG_LOCAL',
'DESHIFTER',
'Tie_Point_Grid',
'io',
'utilities',
'geometry',
'plotting',
'__author__'
'__version__']
...@@ -31,9 +31,9 @@ except ImportError: ...@@ -31,9 +31,9 @@ except ImportError:
# internal modules # internal modules
from .DeShifter import DESHIFTER, _dict_rspAlg_rsp_Int from .DeShifter import DESHIFTER, _dict_rspAlg_rsp_Int
from . import geometry as GEO from . import geometry as GEO
from . import io as IO from . import io as IO
from . import plotting as PLT from . import plotting as PLT
from geoarray import GeoArray from geoarray import GeoArray
from py_tools_ds.convenience.object_oriented import alias_property from py_tools_ds.convenience.object_oriented import alias_property
......
...@@ -21,8 +21,8 @@ from skimage.measure import points_in_poly, ransac ...@@ -21,8 +21,8 @@ from skimage.measure import points_in_poly, ransac
from skimage.transform import AffineTransform, PolynomialTransform from skimage.transform import AffineTransform, PolynomialTransform
# internal modules # internal modules
from .CoReg import COREG from .CoReg import COREG
from . import io as IO from . import io as IO
from py_tools_ds.geo.projection import isProjectedOrGeographic, get_UTMzone, dict_to_proj4, proj4_to_WKT from py_tools_ds.geo.projection import isProjectedOrGeographic, get_UTMzone, dict_to_proj4, proj4_to_WKT
from py_tools_ds.io.pathgen import get_generic_outpath from py_tools_ds.io.pathgen import get_generic_outpath
from py_tools_ds.processing.progress_mon import ProgressBar from py_tools_ds.processing.progress_mon import ProgressBar
......
# -*- coding: utf-8 -*-
"""Top-level package for arosics."""
__author__ = """Daniel Scheffler"""
__email__ = 'daniel.scheffler@gfz-potsdam.de'
__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
__all__=['COREG',
'COREG_LOCAL',
'DESHIFTER',
'Tie_Point_Grid',
'io',
'utilities',
'geometry',
'plotting',
'__author__',
'__version__',
'__versionalias__',]
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