docum updates for wallets

This commit is contained in:
Philip Sargent 2022-08-31 18:49:29 +03:00
parent b6d7057765
commit 7b84fce2ae
2 changed files with 35 additions and 40 deletions

View File

@ -75,7 +75,7 @@ and fill in the line (e.g. 2018#22) for your wallet
<li>Now, if you have not done it immediately after you left the cave,
photograph all the pages of survey notes with your phone.
Get one or more of the people also on the trip to do this too.
<li>Now upload the scanned notes using the <a href="/scanupload/2021:01">Upload Scans</a> form.
<li>Now upload the scanned notes using the <a href="/scanupload/2022:01">Upload Scans</a> form.
Click on the wallet name to the right of the central name on the form
until you are centred on the wallet id of the plastic wallet you have put the notes into.
You can use either your own phone or a laptop connected to the potato hut scanner (instructions below). All you need is the 'expo' password.
@ -121,10 +121,12 @@ should also fill in so that people can find your survey again.</p>-->
<p>As well as looking through the other plastic wallets in this year's lever-arch binder, have a look online at
the <a href="/survey_scans/">list of all online wallets</a> and have a look at all the folders referred to
in your cave in, e.g. here is the data for <a href="/survexfile/204">cave 204</a>: the wallet identifier is
in your cave in, e.g. here is the survex data for <a href="/survexfile/290">cave 290</a>: the wallet identifier is
in the right-most column titles "Scans". (But this is not all the wallets, only those from which a survex file has been created).
If you are doing an entirely new cave, then this page won't exist yet but it
will be where your new discovery is eventually published.
will be where your new discovery is eventually published. A more complete list of the wallets for
a cave is at <a href="/cave/scans/1623-290">cave 1623-290</a> and this shows the online tick-list data
as coloured boxes.
<p>There are also lists of the wallets per year, per cave and per person (surveyor),
e.g. see <a href="/wallets/year/2018">all the wallets for 2018</a>.
@ -237,7 +239,7 @@ file: the numbers for the survey legs (data), the numbers for the LRUDs, and the
<p>Scanned survey notes are voluminous and so are not kept in the version control system. So for safety, if you upload a file with the same name as one already there,
the upload process will add a random suffix to the filename. You will need to contact a nerd to confirm which one you want to keep.
<p>You will be using the expo laptop to do the scanning
<p>You will be using the expo laptop (or some other laptop in the potato hut connected to the scanner) to do the scanning
and you will need to put the scanned files somewhere before you upload them. So to avoid confusion, put them in the folder corresponding
to your wallet name, e.g. for
<a href="/survey_scans/2018%252319/">2018#19</a> put them in:

View File

@ -27,7 +27,8 @@
<ol>
<li>The scans of the survey notebook pages are the ultimate original raw survey data and completely irreplaceable.
<li>The other files in the wallet are part of the process of producing a survey of the cave as a whole.
<li>Individual to-do lists are produced automatically for each caver listing what survey processing tasks they haven't finished yet.
<li>Individual to-do lists are produced automatically for each caver, each cave, and each year. These
have a colour-coded table showing what survey processing tasks they haven't finished yet.
</ol>
<h2>You need to know this bit</h2>
@ -36,9 +37,15 @@ version control</b></font>,
so the most recent person
to change anything <font color=red><b>can overwrite everyone else's work</b></font>.
<h2>What's in the online wallet</h2>
<h3>What's in the online wallet</h3>
<h4>scans in the expofiles/surveyscans/</h4>
<ul>
<li>The <a href="#scans">scanned images</a> of survey notes
</ul>
<h4>metadata in the version control system (drawings/walletjson/)</h4>
<ul>
<li><a href="#status">Progress status</a> of drawing up the survey
<li>Links to <a href="#derived">derived data</a>: survex files, survey drawings
</ul>
@ -96,7 +103,7 @@ Creating a new cave...</a> for the full list of steps.
<p>We keep an index of how many of those steps have been completed in two places:
<ul>
<li>On paper, in the tick boxes in the contents list of this years' survey trips' lever-arch file in the potato hut.
<li>Online in the <em><span style="font-family:monospace">contents.json</span></em> file, a copy of which exists in each trip online wallet.
<li>Online in the <em><span style="font-family:monospace">contents.json</span></em> file, a copy of which exists in the version control system.
</ul>
<p>but the <em><span style="font-family:monospace">contents.json</span></em> file has another,completely different function:
@ -169,7 +176,7 @@ looks like this:
"Jon Arne Toft",
"Becka Lawson"],
"elev not required": false,
"cave": "2018-dm-07",
"cave": "1626-359",
"survex not required": false,
"qms written": true,
"plan not required": false,
@ -178,19 +185,18 @@ looks like this:
"date": "2018-07-13",
"elev drawn": true,
"description url": "",
"survex file": "caves-1626/2018-dm-07/2018-dm-07.svx",
"survex file": "['caves-1626/2018-dm-07/2018-dm-07.svx', 'caves-1626/359/359.svx'] ",
"name": "Homecoming cave"
}
</pre>
Yes, this is <a href="https://en.wikipedia.org/wiki/JSON">a programming format</a>
(standardised in 2013) and every comma is critical.
(Though you can miss off the ".svx" of the survex filenames in the list and it will cope.)
<p>If you feel an urge to edit the file directly, instead of using the online form and checkboxes,
you should take great care with the format and also with also updating the version-controlled copy of
<em><span style="font-family:monospace">contents.json</span></em>
which is committed in the drawings repository. [The drawings repo copy will beocme the master copy
sometime during 2022 and the <em><span style="font-family:monospace">contents.json</span></em> in the same
folder as all the scans will be removed.]
which is committed in the drawings repository. [The drawings repo copy is now, August 2022, the master and only copy.]
<p>
When entering people's names, using the form or with a text editor, it is important not to use any funny characters (such as "?") because
peoples names here are used by the software to construct filenames for the surveying to-do lists. And "?" (for instance) is illegal
@ -214,9 +220,9 @@ on the progress data for the wallet.
<h3>Setting up the online wallets</h3>
<p>When, at the beginning of expo, you create the folder in
<span style="font-family:monospace; size=x-small; background-color: lightgray">expofiles/surveyscans/</span> for the current year, e.g.
<span style="font-family:monospace; size=x-small; background-color: lightgray">/2019/</span>. You will do this on your own laptop or on the expo laptop.
<p>You may also manually create a number of subfolders, e.g. 2019#01, 2019#02 etc. to be ready for the influx of
new trip surveys, though this is absolutely not necessary as the folders are created as-needed by the upload form.
<span style="font-family:monospace; size=x-small; background-color: lightgray">/2023/</span>. You will do this on your own laptop or on the expo laptop.
<p>It is now recommended that you <em>don't</em> manually create a number of subfolders, e.g. 2023#01, 2023#02 etc.
as the folders are created as-needed by the upload form and empty folders can be unecessarily confusing.
<h3>Maintaining the online wallets</h3>
<p>Ideally the cavers who are scanning their notes and typing in the survey data will also be updating the
@ -234,7 +240,7 @@ recently created wallets and to check that names, dates and cave numbers are cor
<h4>Naming the included files</h4>
<p>Troggle detects if there are notesX.jpg planX.jpg and elevX.jpgfiles present, and
<p>Troggle detects if there are notesX.jpg planX.jpg and elevX.jpg files present, and
produces a reminder/warning if they are not,even if these have all been scanned
and given different names.
<p>
@ -248,10 +254,14 @@ warnings disappear. But if tunnel or therion files have already been produced, t
to see what overwriting you will do. These snippets update the server with your recent changes on your own laptop and vice versa, but these days (2022) it is probably easier
to do everything online to the server, and occasionally make a copy to your local machine to keep it synchronised - if you have a laptop you want to use for this sort of thing.
<h4>Surface trips</h4>
<p>For prospecting and surface surveying it is not clear whether the default folder
for the url link to a survex file should be repo :loser: surface/1623/allplateau.svx
<h3>More Troggle magic</h3>
<p> Troggle also
<ul>
<li>checks whether the .svx files listed are actually present <br>in the <a href="../computing/repos.html">:loser: repository</a>
<li>checks whether the .svx files listed are actually present in the <a href="../computing/repos.html">:loser: repository</a>
<li>checks for the presence of notesXXX.jpg, planXXX.jpg and elevXXX.jpg files
<li>checks for the presence of XXXnotes.jpg, XXXplan.jpg, XXXelevation.jpg and XXXelev.jpg files
<li>creates helpful URL links to the existing online survey documentation for the cave being surveyed
@ -265,26 +275,14 @@ to do everything online to the server, and occasionally make a copy to your loca
- checking the date is in the recent past etc.<br><br>
<hr>
The old wallets.py script runs without errors on earliers years before 1999 when there was not the same wallet system, but the results are less useful, e.g. see
http://expo.survex.com/expofiles/surveyscans/1999/
and compare with
http://expo.survex.com/wallets/year/1999
<p>
Old notes, being turned into real documentation...
<br>Much of this just needs deleting..
<pre>
For prospecting and surface surveying it is not clear whether the default folder
for the url link should be repo :loser: surface/1623/allplateau.svx
When there are more than one .svx file there seems to be no way of recording the list
in contents.json so it is impossible to tell what was done on that trip or whether
there is anything missing. This is especially true if it was electronic and the
.topo files are missing. Wookey confirms that this is the case.
HINT
When there are a lot on wallets all with the same cave, make your own template
with the cave name and the right folder prefix for the svx folder
(in the loser repo) and copy it in to all those wallet folders - overwriting
the blank template produced by the wallets.py
# Update March 2019
For 2014 and earlier one needs to do a lot more data entry. The contents.json files for 2014 and earlier do not say who the
@ -296,15 +294,10 @@ http://expo.survex.com/expedition/2014
http://expo.survex.com/survey/2018%2330
This is probably not worth doing except maybe for specific critical connections.
The script runs without errors on each of the years 1999-2014, but the results are less useful, e.g. see
http://expo.survex.com/expofiles/surveyscans/1999/
or
http://expo.survex.com/expofiles/surveyscans/2014/
</pre>
<hr />
</body>