Skip to content

Commit

Permalink
Read the docs is not building it.
Browse files Browse the repository at this point in the history
  • Loading branch information
rserrano committed Dec 2, 2016
1 parent 24c71f6 commit 364fece
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 93 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include geomodelr/cpp/geomodel.hpp
93 changes: 1 addition & 92 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
# geomodelr documentation build configuration file, created by
# sphinx-quickstart on Thu Dec 1 18:22:29 2016.
# sphinx-quickstart on Fri Dec 2 17:18:16 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
Expand Down Expand Up @@ -31,8 +31,6 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.imgmath',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -340,92 +338,3 @@
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The basename for the epub file. It defaults to the project name.
# epub_basename = project

# The HTML theme for the epub output. Since the default themes are not
# optimized for small screen space, using the same theme for HTML and epub
# output is usually not wise. This defaults to 'epub', a theme designed to save
# visual space.
#
# epub_theme = 'epub'

# The language of the text. It defaults to the language option
# or 'en' if the language is not set.
#
# epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A tuple containing the cover image and cover page html template filenames.
#
# epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#
# epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_pre_files = []

# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_post_files = []

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

# The depth of the table of contents in toc.ncx.
#
# epub_tocdepth = 3

# Allow duplicate toc entries.
#
# epub_tocdup = True

# Choose between 'default' and 'includehidden'.
#
# epub_tocscope = 'default'

# Fix unsupported image types using the Pillow.
#
# epub_fix_images = False

# Scale large images.
#
# epub_max_image_width = 0

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# epub_show_urls = 'inline'

# If false, no index is generated.
#
# epub_use_index = True


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
72 changes: 72 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
.. geomodelr documentation master file, created by
sphinx-quickstart on Thu Dec 1 18:22:29 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to geomodelr's query tool documentation!
================================================

Geomodelr is a web tool for creating geological models easily.
To create a geological model, go to https://www.geomodelr.com.
After creating your geological model you might want to use it
for calculations, geostatistics, simulations, or simply to know
what geological unit is present at a given path. With this tool
you can do all that.

To use geomodelr query tool you just need to:

import geomodelr
# load your model.
model = geomodelr.model_from_file('/path/to/your/model_version.json')
# query your model.
unit, distance = model.closest((1000, 1000, 0.0))
# do stuff...
if unit == 'Batholith':
...

You can also use this tool as a script.

$ geomodelr -q /path/to/your/model_version.json
x y z
Batholith


Features
--------
- Query the model in the coordinate system you defined.
- Query the topography heights and query the model with topography in mind.
- Query the intersection of faults and planes.
- Generate grids, use it as a help tool to generate meshes, assign properties for simulations or create block models.
- What do you want to do?

Installation
------------
Install project by calling:

pip install geomodelr

It needs boost libraries and C++ compiler. In case boost libraries are not in a
standard location, call it with INCLUDE_DIRS=... and/or LIBRARY_DIRS=...

Support
-------
If you are having problems, write to support@geomodelr.com.

License
-------
This project is licensed under the Affero GPL license https://www.gnu.org/licenses/

Contents:

.. toctree::
:maxdepth: 2



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

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

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def if_env(**kwargs):
extra_compile_args=['-std=c++11'])

setup(name='geomodelr',
version='0.1',
version='0.1.1',
description='Geomodelr is the open source query tool for geomodelr.com models.',
url='http://github.com/rserrano/geomodelr',
author='Ricardo Serrano',
Expand Down

0 comments on commit 364fece

Please sign in to comment.