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
|
<!DOCTYPE html>
<html>
<head>
<link rel=stylesheet href=style.css />
<link rel=icon href=CZI-new-logo.png />
</head>
<body>
<main>
<div class="goto-index"><a href="index.html">Table of contents</a></div>
<h1>Compatibility across releases</h1>
<h2>Binary data compatibility</h2>
<p>
Depending on how you use Shasta, the code may generate for each run a
<code>Data</code> directory containing binary data
containing the data structures used for assembly.
These binary data can be used for processing in two ways:
<ul>
<li>For
<a href=InspectingResults.html>visualization/debugging</a> using the Shasta http server.
<li>For analysis using the Shasta
<a href=Python.html>Python API</a>.
</ul>
Binary data created by a version of the Shasta assembler
will generally be incompatible with a different version.
In other words, you will only be able to use the http server
or the Python API using the same Shasta version that
was used for the run that you want to postprocess.
<h2>API compatibility</h2>
<p>
The Python API is subject to changes across Shasta versions.
Therefore, a Python script that was developed for a
specific Shasta version is generally not going to continue
to work with future versions.
<p>
Command line options for the Shasta executable and scripts
will generally change across releases.
There is no guarantee that options that were valid in a release
will remain valid in a future release.
It is also possible that the meaning of some options
will change from release to release, although a reasonable
effort will be made to limit this.
<h2>Release numbering</h2>
<p>
Shasta releases are named using
<a href='https://semver.org'>Semantic Versioning</a>
conventions.
Because of the lack of compatibility described above,
it is likely that the Shasta major release number will
stay at 0 for the foreseeable future - that is,
Shasta releases will be numbered <code>0.Y.Z</code>.
<div class="goto-index"><a href="index.html">Table of contents</a></div>
</main>
</body>
</html>
|
