Skip to content

Commit

Permalink
docs: update and outline for German version
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias47n9e committed Apr 25, 2015
1 parent 97cb221 commit 14dbbfb
Show file tree
Hide file tree
Showing 12 changed files with 617 additions and 1 deletion.
52 changes: 52 additions & 0 deletions docs/de/calculations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
.. _calculations:

Berechnungen
============

InnStereo kann eine Reihe von Berechnungen ausführen, die typisch für strukturgeologische Fragestellungen sind und für die Verarbeitung von raumbezogenen Daten eine Erleichterung sind. Konjugierte Strukturen sind im Raum oft durch einfache geometrische Beziehungen verknüpft. Ein Beispiel sind Neckingachsen von Boudins, die immer 90° zur Streckungsachse liegen. Ein statistische aussagkräftiger Datensatz in Kombination mit einer Berechnung kann so die Streckungsachse berechnen auch wenn direkte Messungen von Streckungslinearen nicht möglich sind.

Die Berechnung von raumbezogenen Daten ist oft aufwendig. InnStereo versucht solche Berechnungen möglichst mit nur einem Mausklick abrufbar zu machen. Die folgenden Abschnitte erklären die bereits verfügbaren Berechnungen. Weitere Berechnungen sind in der Entwicklung.

Berechnungen funktionieren nur, wenn nur Ebenen eines Typs (z.B. nur Flächen) selektiert sind. Die Ergebnisse einer Berechnung werden immer als neuer Datensatz dem Projekt hinzugefügt. Der neue Datensatz ist vom alten unabhängig und Änderungen am Ausgangsdatensatz werden nicht an den resultierenden Datensatz weitergegeben.

.. _plane-intersection:

Flächenintersektion
-------------------

Die Berechnung lieftert die Insektion einer Flächenschar. Im Stereonetz ist das der Punkt an dem sich die Großkreise schneiden. Die Berechnung kann verwendet werden um die Faltenachse aus der Messung der Schenkel abzuleiten. Ein anderes Beispiel ist die Berechnung des Intersektionslinears zweier Schieferungen.

.. _best-fitting-plane:

Gemeinsamer Großkreis
---------------------

Der gemeinsame Großkreis kann für eine Gruppe von Linearen berechnet werden. Das Ergebnis ist der Großkreis, auf dem die meisten Lineare liegen.

.. _eigenvector:

Eigenvektoren und Eigenwerte
----------------------------

Diese Methode berechnet die 3 Eigenvektoren und Eigenwerte eines Datensatzes. Der Datensatz unterscheidet automatisch ob Flächen oder Lineare selektiert sind. Das Ergebnis wird als Ebene dem Projekt hinzugefügt. Die Legende zeigt neben dem Symbol der Vektoren, die Einfallrichtung und das Einfallen der Vektoren und deren Eigenwerte in Klammern.

.. _copy-poles:

Flächenpole
-----------

Diese Berechnung kopiert die Flächenpole in eine eigenen Linear-Ebene.

.. _normal-planes:

Normalflächen
-------------

Diese Methode berechnet die Flächen, die normal zu den selektierten Lineare liegen.

.. _calculations-further-reading:

Literatur
---------


49 changes: 49 additions & 0 deletions docs/de/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _changelog:

Änderungsprotokoll
==================

Momentan werden Versionsnummern nach dem folgenden Schema vergeben: Version 1.0 wird die erste stabile Version mit vollem Funktionsumfang sein. Alpha-Versionen geben frühe Einblicke in die Entwicklung. Beta-Versionen werden vergeben wenn das Programm weitgehend vollständig ist. Die jeweils aktuellste Version kann `auf dieser Seite <https://github.com/tobias47n9e/innstereo/releases>`_ heruntergeladen werden.

InnStereo v1.0-alpha.4
----------------------

- [Feature] Im Zentrum des Stereonetzes kann jetzt ein Kreuz angezeigt werden.
- [Feature] Für die randliche Beschriftung des Stereonetzes kann jetzt zwischen einem Symbol für Norden, und Gradangaben gewechselt werden.
- [Feature] Einzelne Datensätze lassen sich jetzt im CSV-Format exportieren.
- [Feature] Die Statusleiste zeigt jetzt einige hilfreiche Meldungen und Warnungen.
- [Feature] Der Ebenen-Dialog merkt sich jetzt die zuletzt angesehene Seite.
- [Feature] Der Ebenen-Dialog kann jetzt auch über einen Knopf in der Menüleiste aufgerufen werden.
- [Feature] Die Windows-Version hat jetzt ein zum Programm passendes Icon.
- [Feature] Die Anzahl der Datensätze einer Ebene wird jetzt in der Legende angezeigt.
- `[Bug] <https://github.com/tobias47n9e/innstereo/issues/7>`_ Die Ergebnisse von Berechnungen liegen jetzt immer im normalen Bereich für Stereonetze.
- [Defaults] Die voreingestellte Standardabweichung für Konturierungen wurde auf 2 gesetzt (Vorher 3).
- [Defaults] Das voreingestellte Aussehen von Linearen und Polpunkten wurde geändert.

InnStereo v1.0-alpha.3
----------------------

- [Feature] Funktion, die den durchschnittlichen Schnittpunkt einer Gruppe von Flächen findet.
- [Feature] Die Fläche, die normal zu einem Linear liegt, lässt sich jetzt berechnen.
- [Bug] Einige verbleibende deutsche Strings wurden ins Englische übersetzt. Die Entwicklungsversionen werden auf Englisch sein um den Arbeitsaufwand geringer zu halten. Übersetzungen werden kurz vor der ersten 1.0-Version hinzugefügt.

InnStereo v1.0-alpha.2
----------------------

- `[Bug] <https://github.com/tobias47n9e/innstereo/issues/1>`_ Ein Fehler in der Paketierung der Windows-Version wurde repariert, der die Verwendung des GtkFileChooserDialogs verhinderte. Dadurch konnten keine Abbildungen gespeichert werden und die Datenimportassistent nicht verwendet werden.
- `[Bug] <https://github.com/tobias47n9e/innstereo/issues/2>`_ Eine Funktion, die den idealen Großkreis einer Gruppe von Linearen findet, ist jetzt verfügbar.

InnStereo v1.0-alpha.1
----------------------

- [Feature] Planare Strukturen können als Großkreise und Polpunkte dargestellt werden.
- [Feature] Lineare Strukturen können dargestellt werden.
- [Feature] Kleinkreisverteilungen mit verschiedenen Öffnungswinkeln.
- [Feature] Unterstüztung für flächentreue und winkeltreue Projektion.
- [Feature] Mehrere Datensätze können verwaltet werden.
- [Feature] Datensätze können auf verschiedene Arten konturiert werden.
- [Feature] CSV-Dateien können importiert werden.
- [Feature] Die Legende wird automatisch generiert.
- [Feature] Für eine Gruppe von Linearen, lässt sich der ideale Großkreis berechnen.
- [Feature] Datensätze können als Rosendiagramm dargestellt werden.
- [Feature] Linien und Punkte haben zahlreiche Formatierungsoptionen.
71 changes: 71 additions & 0 deletions docs/de/dataio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.. _dataio:

Importieren und Exportieren
===========================

In das Programm lassen sich bereits Datensätze importieren. Dazu verwendet man Textdateien, die aus einem Tabellenkalkulationsprogramm exportiert wurden. Dabei ist das CSV-Format am einfachsten zu handhaben.

Datenimport
-----------

Textdateien lassen sich mit dem Datenimport-Dialog öffnen. Dazu muss erst ein passender Datensatz erstellt werden (z.B. einen Flächendatensatz). Dieser wird dann ausgewählt und dann klickt man auf das Symbol für den Datenimport. Danach muss man eine Textdatei auswählen, die im nächsten Schritt geparst wird.

.. figure:: ../_static/interface_file_parser_button.png
:width: 300px
:align: center
:alt: screenshot with location of file parser button highlighted

Der markierte Knopf öffnet den Datenimport-Dialog. Dazu muss auch ein bestehender Datensatz markiert sein.

Nachdem die Textdatei geöffnet wurde, öffnet sich der Datenparser-Dialog. Die Spalten in der Textdatei können den Spalten zugewiesen werden, die InnStereo veröffentlicht. Außerdem können Zeilen am Beginn der Datei übersprungen werden, die Meta-Daten enthalten.

.. figure:: ../_static/interface_file_parser_dialog.png
:width: 400px
:align: center
:alt: screenshot of the file parser dialog

Die Abbildung zeigt den Datenparser-Dialog.

Datenimport von anderen Programmen
----------------------------------

Die meisten älteren und noch verfügbaren Stereonetzprogramme verwenden keine speziellen Dateiformate, sondern setzen auf CSV-ähnliche Dateiformate. Diese können wie im vorherigen Abschnitt beschrieben, importiert werden. Die Dateiformate einiger Stereonetzprogramme werden im folgenden Abschnitt beschrieben.

TectonicsFP
^^^^^^^^^^^

TectonicsFP (Ortner et al., 2002) und seine anderen Versionen TektonikQB, TektonikFB and TectonicVB, benutzen CSV-Dateien mit verschiedenen Dateinamenerweiterungen. Die Dateien und deren Spaltenaufteilung sind in folgender Tabelle aufgelistet.

============== ==================================================== =============== =============================================================================
Dateiendung Beschreibung InnStereo Spalten
============== ==================================================== =============== =============================================================================
pln Fläche Plane Einfallr., Einf., Kommentar
lin Linear Linear Einfallr., Einf., Kommentar
fpl Störungsfläche Faultplane **(1)**, Einfallr. Fläche, Einf. Fläche, Einfallr. Linear, Einf. Linear, Kommentar
cor Korrigierte Störungsf. (Lineare auf Fl. projeziert) Faultplane **(1)**, Einfallr. Fläche, Einf. Fläche, Einfallr. Linear, Einf. Linear, Kommentar
azi Azimuth-Datensatz Linear Einfallrichtung
t** PT-Axen-Datensatz In Entwicklung
============== ==================================================== =============== =============================================================================

Die Tabelle zeigt die von TectonicsFP verwendeten Dateien. **(1)** Die erste Spalte der Störungsflächendatensätze ist eine zweistellige Zahl. Die erste Stelle speichert den Schersinn der Fläche ("0" or "5" = Unbekannt, "1" or "+" = Überschiebung, "2" or "-" = Abschiebung, "3" = Dextral, "4" = Sinistral). Die zweite Zahl steht für die Qualität oder Sicherheit des Messwertes. Die erste Stelle kann im Dateiparser-Dialog eingelesen werden, wenn man die Option "Tectonics FPL Notation" ankreuzt. Die zweite Stelle kann momentan nicht importiert werden.

Datenexport
-----------

Die Daten einzelner Datensätze lassen sich im CSV-Format exportieren. Dazu klickt man auf den Knopf in der linken unteren Leiste. Danach öffnet sich ein Dialog, in dem man den Speicherort und den Dateinamen festlegen kann. Der Knopf funktioniert nur, wenn genau ein Datensatz selektiert ist.

CSV-Dateien lassen sich mit zahlreichen anderen Programmen einfach importieren. Andere Dateiformate oder Datenbankanbindungen sind geplant.

.. figure:: ../_static/interface_file_export_button.png
:width: 400px
:align: center
:alt: screenshot of the position of the file export button

The hervorgehobene Knopf exportiert die Daten der momentan angewählten Ebene.

Literatur
---------

- Beschreibung des `CSV-Formats <https://de.wikipedia.org/wiki/CSV_%28Dateiformat%29>`_ auf Wikipedia
- Ortner, H., Reiter, F. & Acs, P. (2002). *Easy handling of tectonic data: the programs TectonicVB for Mac and TectonicsFP for Windows.* Computers & Geosciences(28/10), 1193-1200 (`doi:10.1016/S0098-3004(02)00038-9 <http://dx.doi.org/10.1016/S0098-3004%2802%2900038-9>`_).
- Reiter, F. & Acs, P., (1996-2011). *TectonicsFP 1.75 - Computer Software for Structural Geology: Operating Manual.* Teil der TectonicsFP-Installation.
41 changes: 41 additions & 0 deletions docs/de/datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. _datasets:

Datensätze
===========

InnStereo hat 5 verschiedene Datensätze, die jeweils bestimmte Anwendungen haben. Die Datensätze werden in den folgenden Abschnitten besprochen.

Planar-Datensätze
-----------------

Planare Datensätze werden für geologische Strukturen verwendet, die als Flächen abstrahiert werden können. Im Stereonetz lassen sich Flächen als Großkreise, oder als Polpunkte darstellen.

.. figure:: ../_static/great_circle_pole.png
:width: 400px
:align: center
:alt: stereonet with great circle and pole

Die Abbildung zeigt eine Fläche als Großkreis und Polpunkt, die 140/40 orientiert ist.

Flächendatensätze können auch die stratigraphische Orientierung speichern. Ein "n" steht für normal und ein "i" für invers. Funktionen, die die stratigraphie berücksichtigen sind noch in der Entwicklung.

Linear-Datensätze
-----------------

Lineare Datensätze werden für Strukturen verwendet, die als Linien abstrahiert werden können. Im Stereonetz erscheinen Linien als Punkte am Durchstichpunkt mit der unteren Halbkugel des Stereonetzes.

Störungs-Datensätze
-------------------

Dieser Datensatz wird für Störungen verwendet. Jede Zeile besteht aus einer Messung der Störungsfläche (Einfallsrichtung und Einfallen), des Linears (Einfallr. und Einf.) und dem bestimmten Schersinn (Sinistral, Dextral, Aufschi
This dataset is used for faults that have a conjugated linear element, associated with the movement along this plane. In the stereonet this appears as a combination of how planes and linear elements are displayed.

Falten-Datensätze
-----------------

Falten-Datensätze sind noch in der Entwicklung.

Kleinkreis-Datensätze
---------------------

Konische Verteilungen können als Kreinkreise im Stereonetz dargestellt werden. Kleinkreise erscheinen im Stereonetz als Ellipsen. Viele lineare Strukturen zeigen aufgrund natürlicher Streuung eine Kleinkreisverteilungen.
104 changes: 104 additions & 0 deletions docs/de/formatting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
.. _formatting:

Abbildungs-Formatierung
=======================

Durch Formattierung lässt sich nicht nur das Aussehen von Information verändern, sondern auch ihre Lesbarkeit. Außerdem hat die Formattierung einen starken Einfluss auf die Art wie Informationen weitergegeben werden. Für wissenschaftliche Publikationen sollte man deswegen berücksichtigen wie man bestimmte Informationen hervorheben kann ohne die Ergebnisse zu verfälschen. Insbesondere die Verwendung von Farbtabellen (oder Farbkarten) wird in letzter zeit kontrovers diskutiert (Siehe: :ref:`formatting-further-reading`).

Die Abbildungen von InnStereo lassen sich auf viele Arten anpassen. Die Linien von Groß- und Kleinkreisen können in Farbe, Stärke angepasst werden. Außerdem kann man durchgezogenene oder strichlierte Linien verwenden. Punkte (Pole oder Lineare) können ebenfalls angepasst werden. Für Konturen stehen verschiedene Farbtabellen zur Verfügung. Außerdem können Konturflächen, Kontulinien und Konturbeschriftungen separate an- und ausgeschaltet werden.

Momentan sind keine erweiterten Layout-Optionen geplant. Diese sollten in einem Vektorzeichenprogramm (z.B. Inkscape) vorgenommen werden. Die Abbildungen sind jedoch auch ohne diese Optionen recht professionell. Für druckfertige Grafiken exportiert man am besten das Bild im PDF-Format und importiert es in Inkscape. Dadurch bleibt auch der Text in der Legende bearbeitbar.

.. _layer-formatting:

Ebenenformatierung
------------------

.. _circle-formatting:

Groß- und Kleinkreise
^^^^^^^^^^^^^^^^^^^^^

.. figure:: ../_static/formatting_great_small_circles.png
:width: 400px
:align: center
:alt: screenshot showing some great and small circles and the layer formatting dialog

-

.. _linear-formatting:

Lineare
^^^^^^^

.. figure:: ../_static/formatting_linears.png
:width: 400px
:align: center
:alt: screenshot showing different formatting of linear structures

-

.. figure:: ../_static/formatting_pole_points.png
:width: 400px
:align: center
:alt: screenshot showing pole points formatting

-

.. _contour-formatting:

Konturen
^^^^^^^^

.. figure:: ../_static/formatting_contour_dialog.png
:width: 400px
:align: center
:alt: screenshot showing the dialog tab for contouring a layer

-

.. figure:: ../_static/formatting_contour_fill.png
:width: 400px
:align: center
:alt: screenshot showing contour fills

-

.. figure:: ../_static/formatting_contour_lines.png
:width: 400px
:align: center
:alt: screenshot showing contour lines

-

.. figure:: ../_static/formatting_contour_fill_and_line.png
:width: 400px
:align: center
:alt: screenshot showing contours with both fills and lines

-

.. _rose-formatting:

Rosendiagramm
^^^^^^^^^^^^^

.. _plot-formatting:

Stereonetz-Formatierung
-----------------------


.. _formatting-further-reading:

Literatur
---------

- Ben A. Van Der Pluijm & Stephen Marshak (2004) *Earth Structure.* 2nd Edition. ISBN: 978-0-393-92467-1
- Einführung zu den `Matplotlib Farbtabellen <http://matplotlib.org/users/colormaps.html>`_
- Liste der `Matplotlib Farbtabellen <http://matplotlib.org/examples/color/colormaps_reference.html>`_
- Jake Vanderplas (2014) `How Bad Is Your Colormap? <https://jakevdp.github.io/blog/2014/10/16/how-bad-is-your-colormap/>`_
- Kristen M. Thyng (2014) `Perceptions of Matplotlib Colormaps <https://www.youtube.com/watch?v=rkDgBvT-giw>`_
- Damon McDougall (2014) `How to Choose a Good Colour Map <https://www.youtube.com/watch?v=Alnc9E1RnD8>`_
- Die offizielle Seite von `Inkscape <https://inkscape.org>`_

13 changes: 12 additions & 1 deletion docs/de/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
.. image:: ../_static/logo_about.png
:width: 400px



Willkommen zur Dokumentation von Innstereo!
Expand All @@ -21,7 +23,16 @@ Contents:
.. toctree::
:numbered:
:maxdepth: 2


interface
stereonet
datasets
formatting
calculations
views
dataio
screenshots
changelog

Index und Tabellen
==================
Expand Down

0 comments on commit 14dbbfb

Please sign in to comment.