expoweb/handbook/troggle/trogarch.html

67 lines
3.9 KiB
HTML
Raw Normal View History

2020-04-02 21:40:30 +01:00
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Handbook Troggle Architecture</title>
2020-04-02 21:40:30 +01:00
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body><style>body { background: #fff url(/images/style/bg-system.png) repeat-x 0 0 }</style>
2020-04-02 21:40:30 +01:00
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Troggle Architecture</h1>
<h3>Troggle data architecture</h3>
<p>
The core of troggle is the data architecture: the set of tables into which all the cave survey and expo data is poured and stored. These tables are what enables us to produce a large number of different but consistent reports and views.
2020-05-20 22:43:56 +01:00
<style>figure {font-weight: bold; font-size: small; font-family: sans-serif;font-variant-caps: small-caps;}</style>
2020-05-18 22:25:07 +01:00
<div style="display: flex">
<div style="flex: 50%">
<figure>
<a href="../i/troggle-tables.jpg">
2020-05-18 22:25:07 +01:00
<img src="../t/troggle-tables-small.jpg" /></a>
2020-05-20 22:43:56 +01:00
<br><figcaption>Tables (Objects)</figcaption>
</figure>
2020-05-18 22:25:07 +01:00
</div>
<div style="flex: 50%">
<figure>
<a href="../i/trogpkg.jpg">
<img src="../t/trogpkg-small.jpg" /></a>
2020-05-20 22:43:56 +01:00
<br><figcaption>Packages</figcaption>
2020-05-18 22:25:07 +01:00
</figure>
</div></div>
<h3>Architecture description</h3>
2020-05-18 22:25:07 +01:00
<p>Read the proposal: "<a href="/expofiles/documents/troggle/troggle_paper.pdf" download>Troggle: a novel system for cave exploration information management</a>", by Aaron Curtis</em>. But remember that this paper is an over-ambitious proposal. Only the core data management features have been built. We have none of the "person management" features, none of the "wallet progress" stuff and only two forms in use: for entering cave and cave entrance data.
<p>
2020-05-18 22:25:07 +01:00
ALSO there have been tables added to the core representation which are not anticipated in that document of this diagram, e.g. Scannedimage, Survexdirectory, Survexscansfolder, Survexscansingle, Tunnelfile, TunnelfileSurvexscansfolders, Survey. See <a href="datamodel.html">Troggle data model</a> python code (15 May 2020).
<h3>Troggle parsers and input files</h3>
2020-05-18 22:25:07 +01:00
<p>To understand how troggle imports the data from the survex files, tunnel files, logbooks etc., see the <a href="trogimport.html">troggle import (databaseReset.py)</a> documentation.
<p>The following separate import operations are managed by the import utility <a href="trogimport.html">(databaseReset.py)</a>:
<ul>
<li>expo logbooks
<li>folk (people)
2020-05-18 22:25:07 +01:00
<li>wallets of notes & scans (surveyscans)
<li>cave survey data - survex files
<li>QMs - question marks
<li>drawings - tunnel & therion files
</ul>
<h3>Files generated by troggle</h3>
<p>There are only two places where this happens. This is where online forms are used to create cave entrance records and cave records. These are created in the database but also exported as files so that when troggle is rebuilt and data reimported the new cave data is there.
<h3>Helpful tools and scripts</h3>
2020-05-18 22:25:07 +01:00
<img class="onleft" width = "100px" src="https://mariadb.com/kb/static/images/logo-2018-black.95f5978ae14d.png">
<img class="onright" width = "80px" src="https://sqlite.org/images/sqlite370_banner.gif">
<p>The public server uses a <a href="https://mariadb.org/about/">MariaDB SQL database</a> and development is usually done using a single-user <a href="https://sqlite.org/about.html">sqlite database</a> which is a standard django option.
<p>
You will find it very useful to see what is going on if you look directly at the data in the database (just a single file in the sqlite case) and browse the data in the tables. A light-weight, simple db browser is <a href="https://sqlitebrowser.org/">DB Browser for SQLite</a>. Connecting directly the the MariaDB database with a control panel or <a href="https://www.mysql.com/products/workbench/">workbench</a> gives even more tools and documentation capabilities.
2020-04-02 21:40:30 +01:00
<hr />
Go on to: <a href="trognotes.html">Troggle uncategorised notes to be edited</a><br />
See: <a href="datamodel.html">Troggle data model</a> in python code <br />
2020-04-02 21:40:30 +01:00
Return to: <a href="trogintro.html">Troggle intro</a><br />
<hr />
</body>
</html>