miili
4 years ago
4 changed files with 435 additions and 0 deletions
Split View
Diff Options
-
+20 -0Makefile
-
+108 -0source/_static/gfz_logo.svg
-
+233 -0source/conf.py
-
+74 -0source/index.rst
+ 20
- 0
Makefile
View File
| @ -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) | |||
+ 108
- 0
source/_static/gfz_logo.svg
View File
| @ -0,0 +1,108 @@ | |||
| <?xml version="1.0" encoding="utf-8"?> | |||
| <!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> | |||
| <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> | |||
| <svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" | |||
| width="119.91" height="83.91" viewBox="0 0 119.91 83.91" enable-background="new 0 0 119.91 83.91" xml:space="preserve"> | |||
| <g> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M29.979,3c-3.735,0-6.678,0.526-9.564,1.717 | |||
| c-5.489,2.278-8.206,5.923-8.206,11.074c0,3.645,1.302,6.238,4.188,8.516c3.169,2.523,7.527,3.715,13.413,3.715 | |||
| c4.641,0,9.055-0.701,13.073-2.173V14.215H27.658l1.019,3.995h5.999v5.537c-1.302,0.42-2.716,0.596-4.471,0.596 | |||
| c-2.547,0-4.698-0.491-6.169-1.367c-1.98-1.227-2.943-3.47-2.943-6.939c0-3.645,0.679-6.273,3.339-7.85 | |||
| c1.358-0.806,3.339-1.227,5.66-1.227c3,0,5.659,0.596,8.206,1.892l4.188-3.049C39.033,3.946,34.732,3,29.979,3L29.979,3L29.979,3z" | |||
| /> | |||
| <polygon fill-rule="evenodd" clip-rule="evenodd" points="53.328,27.742 61.252,27.742 61.252,16.983 71.269,16.983 71.269,12.988 | |||
| 61.252,12.988 61.252,7.416 73.759,7.416 74.664,3.456 53.328,3.456 53.328,27.742 53.328,27.742 "/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M83.314,7.451h12.111c2.377,0,4.019-0.175,4.019-0.175s-1.358,1.086-2.435,2.208 | |||
| L82.522,24.308v3.435h24.562l2.037-3.995H95.878c-1.584,0-3.904,0.14-3.904,0.14s1.188-0.841,2.037-1.717l14.602-15.245v-3.54 | |||
| H85.069L83.314,7.451L83.314,7.451L83.314,7.451z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" fill="#005B9D" d="M119.91,53.951C83.257,45,36.426,45.146,0,54.196 | |||
| C30.586,39.356,88.878,39.215,119.91,53.951L119.91,53.951L119.91,53.951z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M15.321,72.727h1.824c0.615,0,1.107,0.127,1.435,0.368 | |||
| c0.328,0.229,0.492,0.546,0.492,0.952c0,0.419-0.103,0.698-0.349,0.939c-0.39,0.368-0.738,0.458-1.906,0.458h-1.497V72.727 | |||
| L15.321,72.727L15.321,72.727z M12.451,71.292v8.851h2.87v-3.251H16.9c1.578,0,2.193-0.102,2.849-0.292 | |||
| c1.558-0.457,2.46-1.423,2.46-2.591c0-1.016-0.717-1.828-2.05-2.285c-0.8-0.28-1.538-0.432-3.957-0.432H12.451L12.451,71.292 | |||
| L12.451,71.292z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M33.261,76.663c0,1.804-0.778,2.388-2.214,2.388 | |||
| c-1.537,0-2.275-0.508-2.275-2.223c0-1.55,0.656-2.375,2.275-2.375C32.749,74.453,33.261,75.278,33.261,76.663L33.261,76.663 | |||
| L33.261,76.663z M36.398,76.663c0-2.273-2.193-3.416-5.309-3.416c-3.321,0-5.371,1.295-5.371,3.53c0,2.031,1.968,3.467,5.473,3.467 | |||
| C34.656,80.244,36.398,78.797,36.398,76.663L36.398,76.663L36.398,76.663z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M49.467,73.336h-8.938v1.346h2.85v5.461h2.808v-5.461h2.747 | |||
| C48.934,74.682,49.488,73.336,49.467,73.336L49.467,73.336L49.467,73.336z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M62.549,77.907c0-1.041-1.189-1.701-3.116-1.98l-1.476-0.216 | |||
| c-0.922-0.127-1.147-0.279-1.147-0.61c0-0.381,0.615-0.622,1.476-0.622c0.861,0,1.824,0.165,2.87,0.508l1.292-1.181 | |||
| c-1.025-0.419-2.727-0.698-4.223-0.698c-2.645,0-4.469,0.914-4.469,2.171c0,0.381,0.144,0.725,0.451,1.055 | |||
| c0.41,0.457,1.21,0.774,2.399,0.965l1.394,0.203c1.004,0.127,1.435,0.394,1.435,0.762c0,0.471-0.656,0.673-1.947,0.673 | |||
| c-1.209,0-2.132-0.202-3.28-0.508l-0.902,1.295c1.333,0.395,2.706,0.572,4.039,0.572C60.479,80.295,62.549,79.355,62.549,77.907 | |||
| L62.549,77.907L62.549,77.907z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M74.03,76.942c0,1.474-0.861,1.879-1.845,1.879h-1.313v-4.216h1.005 | |||
| C73.579,74.605,74.03,75.457,74.03,76.942L74.03,76.942L74.03,76.942z M77.085,76.803c0-2.058-1.641-3.213-4.325-3.403 | |||
| c-0.472-0.038-1.538-0.038-2.256-0.038h-2.419v6.781h2.851c0.84,0,1.394,0,1.864-0.038C75.26,79.914,77.085,78.784,77.085,76.803 | |||
| L77.085,76.803L77.085,76.803z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M87.357,77.438h-1.988c0.328-0.724,0.8-1.841,1.024-2.527 | |||
| C86.599,75.597,87.05,76.727,87.357,77.438L87.357,77.438L87.357,77.438z M91.703,80.143l-3.813-6.845h-2.788l-4.059,6.845h2.89 | |||
| l0.779-1.448h3.26l0.84,1.448H91.703L91.703,80.143L91.703,80.143z"/> | |||
| <path fill-rule="evenodd" clip-rule="evenodd" d="M108.723,80.143l-1.127-6.807h-3.443l-1.456,3.086 | |||
| c-0.185,0.394-0.328,0.8-0.472,1.219c-0.123-0.432-0.246-0.711-0.451-1.155l-1.394-3.149h-3.424l-1.188,6.807h2.768l0.349-3.251 | |||
| c0.062-0.419,0.102-0.901,0.122-1.371c0.165,0.546,0.39,1.066,0.533,1.371l1.477,3.238h2.336l1.641-3.34 | |||
| c0.185-0.355,0.41-0.724,0.554-1.117c0.041,0.47,0.082,0.8,0.122,1.155l0.369,3.314H108.723L108.723,80.143L108.723,80.143z"/> | |||
| <polygon points="12.329,59.27 13.222,59.27 13.222,62.475 16.449,62.475 16.449,59.27 17.365,59.27 17.365,66.93 16.449,66.93 | |||
| 16.449,63.223 13.222,63.223 13.222,66.93 12.329,66.93 12.329,59.27 "/> | |||
| <path d="M20.824,63.636h2.546c-0.011-0.603-0.089-0.971-0.257-1.239c-0.19-0.302-0.581-0.491-1.005-0.491 | |||
| C21.315,61.905,20.869,62.485,20.824,63.636L20.824,63.636z M23.828,65.802l0.335,0.559c-0.491,0.447-1.161,0.692-1.876,0.692 | |||
| c-1.541,0-2.468-1.117-2.468-2.959c0-0.938,0.19-1.552,0.67-2.1c0.447-0.524,0.994-0.781,1.664-0.781 | |||
| c0.604,0,1.139,0.212,1.508,0.614c0.48,0.491,0.614,1.016,0.636,2.345v0.123h-3.473v0.134c0,0.524,0.067,0.927,0.257,1.218 | |||
| c0.313,0.479,0.827,0.681,1.385,0.681C23.002,66.327,23.437,66.159,23.828,65.802L23.828,65.802z"/> | |||
| <path d="M26.764,58.991l0.904-0.179c0.145,0.424,0.134,1.05,0.134,1.719v5.282c0,0.436,0.067,0.558,0.313,0.558 | |||
| c0.033,0,0.112-0.022,0.112-0.022l0.178,0.569c-0.224,0.102-0.324,0.124-0.558,0.124c-0.279,0-0.491-0.079-0.659-0.234 | |||
| c-0.201-0.179-0.268-0.392-0.268-0.793v-5.483C26.92,59.694,26.897,59.382,26.764,58.991L26.764,58.991z"/> | |||
| <path d="M30.604,61.437l0.849-0.201c0.112,0.224,0.201,0.547,0.201,0.781v0.045c0.257-0.268,0.369-0.346,0.681-0.536 | |||
| c0.357-0.212,0.636-0.302,0.938-0.302c0.436,0,0.86,0.224,1.105,0.559c0.079,0.111,0.124,0.179,0.19,0.368 | |||
| c0.536-0.569,1.217-0.927,1.787-0.927c0.826,0,1.396,0.626,1.396,1.508v4.198h-0.893V62.82c0-0.535-0.246-0.814-0.714-0.814 | |||
| c-0.268,0-0.559,0.111-0.815,0.301c-0.167,0.124-0.357,0.279-0.558,0.47l-0.101,0.089v4.064h-0.882v-3.952 | |||
| c0-0.48-0.011-0.559-0.156-0.715c-0.134-0.157-0.313-0.224-0.57-0.224c-0.424,0-0.837,0.212-1.418,0.737v4.153h-0.837v-4.143 | |||
| C30.805,62.017,30.783,61.894,30.604,61.437L30.604,61.437z"/> | |||
| <path d="M40.484,58.969l0.871-0.168c0.101,0.369,0.146,0.726,0.146,1.284v1.296c0,0.212-0.011,0.469-0.034,0.759 | |||
| c0.212-0.201,0.313-0.279,0.559-0.436c0.469-0.313,0.86-0.446,1.295-0.446c0.67,0,1.262,0.368,1.429,0.882 | |||
| c0.067,0.224,0.089,0.402,0.089,0.804v3.986h-0.859v-3.841c0-0.413-0.067-0.658-0.212-0.826c-0.134-0.135-0.369-0.224-0.648-0.224 | |||
| c-0.536,0-1.139,0.346-1.619,0.938v3.952h-0.871v-6.855C40.629,59.594,40.596,59.359,40.484,58.969L40.484,58.969z"/> | |||
| <path d="M49.863,61.961c-0.492,0-0.938,0.246-1.139,0.603c-0.179,0.347-0.268,0.793-0.268,1.452c0,0.781,0.134,1.474,0.346,1.82 | |||
| c0.201,0.335,0.647,0.558,1.127,0.558c0.581,0,1.016-0.302,1.206-0.837c0.123-0.347,0.167-0.659,0.167-1.206 | |||
| c0-0.782-0.078-1.307-0.256-1.675C50.812,62.185,50.32,61.961,49.863,61.961L49.863,61.961z M49.874,61.246 | |||
| c0.926,0,1.529,0.425,1.909,0.972c0.346,0.502,0.514,1.161,0.514,2.065c0,1.084-0.257,1.765-0.871,2.301 | |||
| c-0.436,0.379-0.894,0.535-1.519,0.535c-1.485,0-2.4-1.127-2.4-2.959C47.507,62.352,48.411,61.246,49.874,61.246L49.874,61.246z"/> | |||
| <path d="M54.875,58.991l0.904-0.179c0.145,0.424,0.134,1.05,0.134,1.719v5.282c0,0.436,0.067,0.558,0.313,0.558 | |||
| c0.034,0,0.112-0.022,0.112-0.022l0.179,0.569c-0.224,0.102-0.324,0.124-0.558,0.124c-0.279,0-0.491-0.079-0.659-0.234 | |||
| c-0.201-0.179-0.268-0.392-0.268-0.793v-5.483C55.031,59.694,55.009,59.382,54.875,58.991L54.875,58.991z"/> | |||
| <path d="M61.295,61.358l-0.268,0.681h-1.173v3.573c0,0.614,0.167,0.826,0.715,0.826c0.246,0,0.402-0.033,0.558-0.111l0.123,0.558 | |||
| c-0.279,0.146-0.591,0.224-0.982,0.224c-0.291,0-0.514-0.056-0.726-0.156c-0.391-0.189-0.536-0.547-0.536-1.105v-3.808H58.28 | |||
| v-0.681h0.726v-0.067c0-0.279,0.022-0.592,0.078-1.161l0.011-0.146l0.904-0.2c0,0-0.112,0.837-0.112,1.574H61.295L61.295,61.358z" | |||
| /> | |||
| <polygon points="63.271,61.381 66.978,61.381 66.978,62.095 64.086,66.26 67.156,66.26 66.743,66.93 63.036,66.93 63.036,66.26 | |||
| 66.063,62.073 63.271,62.073 63.271,61.381 "/> | |||
| <path d="M79.136,59.795l-0.492,0.592c-0.457-0.335-0.893-0.48-1.451-0.48c-0.882,0-1.519,0.458-1.887,1.317 | |||
| c-0.224,0.514-0.323,1.128-0.323,2.032c0,0.737,0.066,1.173,0.245,1.619c0.391,0.961,1.184,1.407,2.055,1.407 | |||
| c0.569,0,1.005-0.146,1.496-0.491l0.491,0.637c-0.614,0.401-1.374,0.625-2.133,0.625c-1.865,0-3.148-1.608-3.148-3.931 | |||
| c0-2.277,1.362-3.952,3.216-3.952C77.94,59.17,78.61,59.393,79.136,59.795L79.136,59.795z"/> | |||
| <path d="M82.082,63.636h2.546c-0.011-0.603-0.089-0.971-0.257-1.239c-0.189-0.302-0.58-0.491-1.005-0.491 | |||
| C82.573,61.905,82.127,62.485,82.082,63.636L82.082,63.636z M85.086,65.802l0.335,0.559c-0.491,0.447-1.161,0.692-1.876,0.692 | |||
| c-1.541,0-2.468-1.117-2.468-2.959c0-0.938,0.19-1.552,0.671-2.1c0.446-0.524,0.993-0.781,1.663-0.781 | |||
| c0.603,0,1.14,0.212,1.508,0.614c0.479,0.491,0.614,1.016,0.636,2.345v0.123h-3.473v0.134c0,0.524,0.067,0.927,0.257,1.218 | |||
| c0.313,0.479,0.827,0.681,1.385,0.681C84.26,66.327,84.695,66.159,85.086,65.802L85.086,65.802z"/> | |||
| <path d="M87.977,61.47l0.849-0.234c0.146,0.313,0.201,0.547,0.201,0.87c0.581-0.58,1.161-0.859,1.753-0.859 | |||
| c0.604,0,1.14,0.324,1.362,0.815c0.09,0.201,0.134,0.424,0.134,0.647v4.221h-0.882v-3.763c0-0.592-0.033-0.748-0.201-0.927 | |||
| c-0.122-0.146-0.357-0.234-0.614-0.234c-0.446,0-1.139,0.357-1.541,0.781v4.143h-0.848v-4.143 | |||
| C88.189,62.017,88.167,61.894,87.977,61.47L87.977,61.47z"/> | |||
| <path d="M97.646,61.358l-0.268,0.681h-1.173v3.573c0,0.614,0.168,0.826,0.715,0.826c0.245,0,0.402-0.033,0.559-0.111l0.122,0.558 | |||
| c-0.278,0.146-0.592,0.224-0.982,0.224c-0.29,0-0.514-0.056-0.726-0.156c-0.391-0.189-0.536-0.547-0.536-1.105v-3.808h-0.726 | |||
| v-0.681h0.726v-0.067c0-0.279,0.022-0.592,0.078-1.161l0.012-0.146l0.904-0.2c0,0-0.112,0.837-0.112,1.574H97.646L97.646,61.358z" | |||
| /> | |||
| <path d="M99.811,61.459l0.871-0.235c0.135,0.29,0.19,0.458,0.19,0.827v0.077c0.402-0.569,0.994-0.927,1.563-0.927 | |||
| c0.146,0,0.302,0.057,0.302,0.057l-0.357,0.949c-0.111-0.034-0.145-0.045-0.245-0.045c-0.335,0-0.67,0.145-0.927,0.401 | |||
| s-0.324,0.425-0.324,0.883v3.483h-0.871v-4.243C100.012,62.051,99.967,61.815,99.811,61.459L99.811,61.459z"/> | |||
| <path d="M105.182,63.636h2.545c-0.011-0.603-0.089-0.971-0.256-1.239c-0.19-0.302-0.581-0.491-1.005-0.491 | |||
| C105.673,61.905,105.226,62.485,105.182,63.636L105.182,63.636z M108.185,65.802l0.335,0.559c-0.491,0.447-1.161,0.692-1.875,0.692 | |||
| c-1.541,0-2.469-1.117-2.469-2.959c0-0.938,0.19-1.552,0.671-2.1c0.446-0.524,0.993-0.781,1.663-0.781 | |||
| c0.604,0,1.14,0.212,1.508,0.614c0.48,0.491,0.614,1.016,0.637,2.345v0.123h-3.473v0.134c0,0.524,0.066,0.927,0.256,1.218 | |||
| c0.313,0.479,0.827,0.681,1.385,0.681C107.358,66.327,107.794,66.159,108.185,65.802L108.185,65.802z"/> | |||
| </g> | |||
| </svg> | |||
+ 233
- 0
source/conf.py
View File
| @ -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} | |||
+ 74
- 0
source/index.rst
View File
| @ -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 | |||