Skip to content

Commit

Permalink
Publish telluric
Browse files Browse the repository at this point in the history
  • Loading branch information
astrojuanlu committed Apr 10, 2018
0 parents commit a9295cd
Show file tree
Hide file tree
Showing 84 changed files with 9,244 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**/*.tif
!tests/data/**/*.tif
.eggs
.git
.gitignore
.cache
.coverage
.mypy_cache
.vscode
.flake8
rasters
osm
5 changes: 5 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[flake8]
max-line-length=119
exclude=.git
select=E,W,F,C,N
ignore=
56 changes: 56 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
*.py[cod]
local_settings.py

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64
__pycache__

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox
nosetests.xml

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject
media
celerybeat-schedule
static
venv
.tags

# Jupyter notebooks
.ipynb_checkpoints

# MyPy cache
.mypy_cache

# Other
.cache
.eggs
.vscode
reports
.gitattributes
.tif
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
How to contribute
-----------------

- Write pep8 complaint code.
- Wrap the code on 120 columns.
- Always use a branch for each feature and Merge Proposals.
- Always run the tests before to push. (test implies pep8 validation)
26 changes: 26 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Development environment for telluric
# Analyzed with https://www.fromlatest.io/
FROM debian:jessie-backports
LABEL maintainer="Juan Luis Cano <[email protected]>"

RUN set -x \
&& apt-get update \
&& apt-get install --no-install-recommends -t jessie-backports -y \
wget python3-all-dev python3-all python3-tk \
ca-certificates wget build-essential \
&& rm -rf /var/lib/apt/lists/* \
&& apt-get clean

RUN wget -O - https://bootstrap.pypa.io/get-pip.py | python3
RUN set -x \
&& pip3 install pip -U \
&& pip3 install numpy

# Patch for GDAL vsicull to work of https
RUN mkdir -p /etc/pki/tls/certs/
RUN cp /etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crt

WORKDIR /usr/src
COPY . /usr/src

RUN pip3 install --editable .[dev]
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include versioneer.py
include telluric/_version.py
18 changes: 18 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
DOCKER_IMAGE?=telluric:latest

.PHONY: build dockershell test test-fast test-manual devshell

build:
docker build --pull -t ${DOCKER_IMAGE} .

dockershell:
docker run --rm -v `pwd`:/usr/src -it ${DOCKER_IMAGE} /bin/bash

test:
docker run --rm ${DOCKER_IMAGE} python3 -m pytest

test-fast:
docker run --rm -v `pwd`:/usr/src ${DOCKER_IMAGE} python3 -m pytest --color=yes

test-manual:
docker run --rm --env TEST_MANUAL=1 -v `pwd`:/usr/src ${DOCKER_IMAGE} python3 -m pytest -k ManualTest -s
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# telluric

## Overview

telluric is a Python library to manage vector and raster geospatial data in an interactive
and easy way.

## Development

for full tests do:

`$ make build`
`$ make test`

for testing single tests do:

`$ make dockershell`
`docker$ python -m pytest TEST_FILE::TEST_NAME`
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = Telluric
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 changes: 14 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
API Reference
=============

telluric.features module
------------------------

.. automodule:: telluric.features
:members:

telluric.vectors module
-----------------------

.. automodule:: telluric.vectors
:members:
182 changes: 182 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Telluric documentation build configuration file, created by
# sphinx-quickstart on Thu Jul 27 11:04:22 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'nbsphinx',
'IPython.sphinxext.ipython_console_highlighting',
]

# Intersphinx configuration
intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", None),
"sqlalchemy": ("https://docs.sqlalchemy.org/en/latest/", None),
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Telluric'
copyright = '2017, Satellogic'
author = 'Juan Luis Cano, Slava Kerner, Lucio Torre'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.0'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Telluricdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Telluric.tex', 'Telluric Documentation',
'Juan Luis Cano, Slava Kerner, Lucio Torre', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'telluric', 'Telluric Documentation',
[author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Telluric', 'Telluric Documentation',
author, 'Telluric', 'One line description of project.',
'Miscellaneous'),
]
21 changes: 21 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. Telluric documentation master file, created by
sphinx-quickstart on Thu Jul 27 11:04:22 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Telluric's documentation!
====================================

.. toctree::
:maxdepth: 2
:caption: Contents:

api


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Loading

0 comments on commit a9295cd

Please sign in to comment.