miili
5 years ago
4 changed files with 435 additions and 0 deletions
@ -0,0 +1,20 @@ |
|||
# Minimal makefile for Sphinx documentation
|
|||
#
|
|||
|
|||
# You can set these variables from the command line.
|
|||
SPHINXOPTS = |
|||
SPHINXBUILD = sphinx-build |
|||
SPHINXPROJ = Pyrockoorg |
|||
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) |
|||
|
After Width: | Height: | Size: 11 KiB |
@ -0,0 +1,233 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# |
|||
# Pyrocko.org documentation build configuration file, created by |
|||
# sphinx-quickstart on Thu Jan 5 14:42:11 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('.')) |
|||
import sphinx_sleekcat_theme |
|||
|
|||
# -- 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.intersphinx', |
|||
'sphinx.ext.githubpages'] |
|||
|
|||
# Add any paths that contain templates here, relative to this directory. |
|||
templates_path = ['_templates'] |
|||
|
|||
# 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 = u'Pyrocko.org' |
|||
copyright = u'2017, The Pyrocko Developers' |
|||
author = u'' |
|||
|
|||
# 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 = u'' |
|||
# The full version, including alpha/beta/rc tags. |
|||
release = u'' |
|||
|
|||
# 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_sleekcat_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 = { |
|||
# 'githuburl': 'https://github.com/pyrocko/pyrocko/', |
|||
'bodyfont': '"Lucida Grande",Arial,sans-serif', |
|||
'headfont': '"Lucida Grande",Arial,sans-serif', |
|||
'codefont': 'monospace,sans-serif', |
|||
'linkcolor': '#204a87', |
|||
'visitedlinkcolor': '#204a87', |
|||
'nosidebar': True, |
|||
# 'appendcss': open('style.css').read(), |
|||
# 'googlewebfonturl': 'https://fonts.googleapis.com/css?family=Roboto+Slab', |
|||
# 'bodyfont': '"Roboto Slab",Arial,sans-serif', |
|||
} |
|||
pygments_style = 'friendly' |
|||
|
|||
# Add any paths that contain custom themes here, relative to this directory. |
|||
html_theme_path = [sphinx_sleekcat_theme.get_html_theme_path()] |
|||
|
|||
# The name for this set of Sphinx documents. If None, it defaults to |
|||
# "<project> v<release> documentation". |
|||
html_title = u"%s" % (project) |
|||
|
|||
# A shorter title for the navigation bar. Default is the same as html_title. |
|||
#html_short_title = u"%s Manual" % project |
|||
|
|||
# The name of an image file (relative to this directory) to place at the top |
|||
# of the sidebar. |
|||
html_logo = None |
|||
|
|||
# The name of an image file (within the static path) to use as favicon of the |
|||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|||
# pixels large |
|||
#html_favicon = None |
|||
|
|||
# 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 = ['_static'] |
|||
|
|||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|||
# using the given strftime format. |
|||
#html_last_updated_fmt = '%b %d, %Y' |
|||
|
|||
# If true, SmartyPants will be used to convert quotes and dashes to |
|||
# typographically correct entities. |
|||
#html_use_smartypants = True |
|||
|
|||
# Custom sidebar templates, maps document names to template names. |
|||
#html_sidebars = {} |
|||
|
|||
# Additional templates that should be rendered to pages, maps page names to |
|||
# template names. |
|||
#html_additional_pages = {} |
|||
|
|||
# If false, no module index is generated. |
|||
#html_domain_indices = True |
|||
|
|||
# If false, no index is generated. |
|||
#html_use_index = True |
|||
|
|||
# If true, the index is split into individual pages for each letter. |
|||
#html_split_index = False |
|||
|
|||
# If true, links to the reST sources are added to the pages. |
|||
#html_show_sourcelink = True |
|||
|
|||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|||
html_show_sphinx = False |
|||
|
|||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|||
#html_show_copyright = True |
|||
|
|||
# If true, an OpenSearch description file will be output, and all pages will |
|||
# contain a <link> tag referring to it. The value of this option must be the |
|||
# base URL from which the finished HTML is served. |
|||
html_use_opensearch = 'http://pyrocko.org/' |
|||
|
|||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
|||
#html_file_suffix = None |
|||
|
|||
# Output file base name for HTML help builder. |
|||
htmlhelp_basename = 'Pyrocko' |
|||
|
|||
|
|||
# -- Options for HTMLHelp output ------------------------------------------ |
|||
|
|||
# Output file base name for HTML help builder. |
|||
htmlhelp_basename = 'Pyrocko' |
|||
|
|||
|
|||
# -- 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, 'Pyrockoorg.tex', u'Pyrocko.org Documentation', |
|||
u'The Pyrocko Developers', '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, 'pyrockoorg', u'Pyrocko.org 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, 'Pyrockoorg', u'Pyrocko.org Documentation', |
|||
author, 'Pyrockoorg', 'One line description of project.', |
|||
'Miscellaneous'), |
|||
] |
|||
|
|||
|
|||
|
|||
|
|||
# Example configuration for intersphinx: refer to the Python standard library. |
|||
intersphinx_mapping = {'https://docs.python.org/': None} |
|||
@ -0,0 +1,74 @@ |
|||
.. image:: http://pyrocko.org/v0.3/_images/pyrocko_shadow.png |
|||
:align: left |
|||
|
|||
******************************* |
|||
Pyrocko - Geophysical Framework |
|||
******************************* |
|||
|
|||
Pyrocko is an open source seismology toolbox and library, written in the Python programming language and developed at the `GFZ Potsdam <http://www.gfz-potsdam.de>`_. |
|||
|
|||
.. raw:: html |
|||
|
|||
<div style="clear:both"></div> |
|||
|
|||
|
|||
Pyrocko Framework |
|||
================= |
|||
Pyrocko is the foundation of wonderful seismological tools prospering in its open-source ecosystem_. These tools can be seen as mere frameworks enabling researchers and students rapid development of seismological software and answer questions in seismology. |
|||
|
|||
Tutorials and References |
|||
------------------------ |
|||
* Download & Installation |
|||
* Examples |
|||
* Reference Manual |
|||
|
|||
Apps |
|||
---- |
|||
Pyrocko contains standalone applications assisting in everyday seismological practice: |
|||
|
|||
* Snuffler |
|||
* An extensible seismogram browser and workbench |
|||
* Cake |
|||
* Travel-time and ray-path computations for 1D layered earthmodels |
|||
* Fomosto |
|||
* A tool to calculate and manage Green's functions stores |
|||
* Jackseis |
|||
* A command-line tool for common waveform archive data manipulations |
|||
|
|||
.. _ecosystem: |
|||
|
|||
Pyrocko Ecosystem |
|||
================= |
|||
|
|||
|
|||
Grond - Earthquake Source Inversion |
|||
----------------------------------- |
|||
Bootstrap-based probabilistic battering ram to explore solution spaces in earthquake source parameter estimation problems. |
|||
|
|||
Kite - InSAR Displacement |
|||
------------------------- |
|||
Handling InSAR displacement the pyrocko way. Inspection of static displacement, noise analysis and error estimation of satellite InSAR data. |
|||
|
|||
Lassie - Earthquake Detector |
|||
---------------------------- |
|||
Rumble in the Bronx! Lassie is the pal at your side investigating regional earthquake activitiy. |
|||
|
|||
Additional Resources |
|||
==================== |
|||
* Pyrocko project page on GitHub |
|||
* Snuffler tutorial (with screenshots) |
|||
* Repository of user contributed Snufflings (http://www.github.com/pyrocko/contrib-snufflings) |
|||
* Webservice: Pre-calculated Green's function stores |
|||
* EGU2014 poster: Synthetic seismogram web service and Python tools |
|||
|
|||
Developed at |
|||
============ |
|||
.. image:: _static/gfz_logo.svg |
|||
:align: right |
|||
|
|||
|
|||
.. meta:: |
|||
:description: Pyrocko is an open source seismology environment. |
|||
:keywords: Seismology, Earthquake, Geodesy, Earth, Science, Software, Python, software development, open source, |
|||
:audience: scientists, students, researcher, software developer |
|||
:robots: index, follow |
|||
Loading…
Reference in new issue