File: intro.htm

package info (click to toggle)
survex 1.4.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 14,268 kB
  • sloc: ansic: 21,446; cpp: 18,495; sh: 5,401; javascript: 831; perl: 755; makefile: 610; python: 83; xml: 35
file content (177 lines) | stat: -rw-r--r-- 7,933 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!DOCTYPE html>

<html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Introduction &#8212; Survex 1.4.17 documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
    <script src="_static/documentation_options.js?v=91e0adf2"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="genindex.htm" />
    <link rel="search" title="Search" href="search.htm" />
    <link rel="next" title="Getting Started" href="getstart.htm" />
    <link rel="prev" title="Survex 1.4.17 Manual" href="index.htm" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  

  
  

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <section id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1>
<p>This section describes what Survex is, and outlines the scope of this manual.</p>
<section id="about-survex">
<h2>About Survex<a class="headerlink" href="#about-survex" title="Link to this heading">¶</a></h2>
<p>Survex is a multi-platform Free and Open-Source Software cave surveying
package.  Versions 1.2 and later run on Linux, other UNIX-like platforms,
Microsoft Windows, and macOS.  We’re investigating support for phones and
tablets.</p>
<p>We are well aware that not everyone has access to super hardware - often
surveying projects are run on little or no budget and any computers used are
donated.  We aim to ensure that Survex is feasible to use on low-spec machines.
Obviously it won’t be as responsive, but we intend it to be usable.  Please
help us to achieve this by giving us some feedback if you use Survex on a slow
machine.</p>
<p>Survex is capable of processing extremely complex caves very quickly and has a
very effective, real-time cave viewer which allows you to rotate, zoom, and pan
the cave using mouse or keyboard.  We have tested it extensively using CUCC and
ARGE’s surveys of the caves under the Loser Plateau in Austria (over 90,000
survey legs and over 350km of underground survey data).  This can all be
processed in around 13 seconds on a computer bought in 2012.</p>
<p>Survex is also used by many other survey projects around the world, including
the <a class="reference external" href="https://www.oucc.org.uk/draenen/draenenmain.htm">Ogof Draenen</a>
survey, the <a class="reference external" href="http://www.easegill.org.uk/">Easegill</a> resurvey project, the OFD
survey, the <a class="reference external" href="https://www.oucc.org.uk/expeditions/expeditions-spain.htm">OUCC Picos expeditions</a>, and the Hong Meigui
China expeditions.</p>
<p>Survex is still actively being worked on.  Version 1.0 was complete in some
sense, but development has continued since.</p>
<p>We encourage feedback from users on important features or problems, which will
help to direct future development.  See the “Mailing List” section of this
manual for the best way to contact us.</p>
</section>
<section id="about-this-manual">
<h2>About this Manual<a class="headerlink" href="#about-this-manual" title="Link to this heading">¶</a></h2>
<p>If there’s a part of this manual you find hard to understand, please do let us
know.  We already know Survex well, so it can be hard for us to spot areas
where the manual doesn’t given enough information, or doesn’t explain things
clearly enough to follow when you don’t know what’s going on.  It’s helpful is
you can suggest a better wording, but don’t worry if you can’t, just explain
the problem as precisely as you can.</p>
<p>The master version of this manual is maintained as <a class="reference external" href="https://docutils.sourceforge.io/rst.html">reStructured Text</a>, and
automatically converted to a number of other formats.  If you are going to send
us <em>major</em> changes, it’s much easier to include them if you work from this
master version rather than changing one of the generated files.</p>
<section id="terminology">
<h3>Terminology<a class="headerlink" href="#terminology" title="Link to this heading">¶</a></h3>
<p>Throughout this document we use British terminology for surveying:</p>
<dl class="simple">
<dt>station</dt><dd><p>a point in the cave that you survey from and/or to</p>
</dd>
<dt>leg</dt><dd><p>a line joining two stations</p>
</dd>
<dt>survey</dt><dd><p>a group of legs surveyed on the same trip</p>
</dd>
</dl>
</section>
</section>
</section>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.htm">Survex</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#about-survex">About Survex</a></li>
<li class="toctree-l2"><a class="reference internal" href="#about-this-manual">About this Manual</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#terminology">Terminology</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getstart.htm">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmdline.htm">Survex Programs</a></li>
<li class="toctree-l1"><a class="reference internal" href="datafile.htm">Survex data files</a></li>
<li class="toctree-l1"><a class="reference internal" href="svxhowto.htm"><code class="docutils literal notranslate"><span class="pre">.svx</span></code> Cookbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="genhowto.htm">General: How do I?</a></li>
<li class="toctree-l1"><a class="reference internal" href="compass.htm">Larry Fish’s Compass</a></li>
<li class="toctree-l1"><a class="reference internal" href="walls.htm">David McKenzie’s Walls</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmap.htm">Bob Thrun’s CMAP</a></li>
<li class="toctree-l1"><a class="reference internal" href="img.htm">Using the img library</a></li>
<li class="toctree-l1"><a class="reference internal" href="maillist.htm">Mailing List</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.htm">Future Developments</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.htm">Documentation overview</a><ul>
      <li>Previous: <a href="index.htm" title="previous chapter">Survex 1.4.17 Manual</a></li>
      <li>Next: <a href="getstart.htm" title="next chapter">Getting Started</a></li>
  </ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.htm" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &#169;1998-2025.
      
      |
      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
      
    </div>

    

    
  </body>
</html>