Skip to content

Commit ef6c444

Browse files
committed
Uniquely Identify SPM dev version
1 parent b0387da commit ef6c444

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed
66.3 KB
Loading
52.9 KB
Loading
75.4 KB
Loading

docs/development/versioning.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,43 @@ where v is the version and r is the release. For convenience, to return the vers
2626
```Matlab
2727
spm('version')
2828
```
29+
please note that when using the development version of SPM the release string will be 00.00
30+
31+
## Uniquely identifying the development version of SPM
32+
If you use the development version of SPM you will need to be able to uniquely identify what version of SPM that you are using. This is important when you either write papers or share code with others. By way of example let's say you were using the development version that was available on the 18th of February 2025. To uniquely identify this version of SPM you must first locate the commit associated with the version you are using. This can easily be done by pressing the commits button in the repository
33+
34+
<figure markdown>
35+
<div class="center">
36+
<img src="../assets/figures/development/commit.png" />
37+
</div>
38+
</figure>
39+
40+
When you press this button you will be redirected to the list of commits over time. Hovering your mouse over the two angular brackets next to the appropriate commit will allow you to explore the repository at that point in time.
41+
42+
43+
<figure markdown>
44+
<div class="center">
45+
<img src="../assets/figures/development/browse.png" />
46+
</div>
47+
</figure>
48+
49+
When you click on these brackets you will be redirected to the repository at that point in time. You can now
50+
51+
1. Hover over the code button
52+
2. Click download ZIP
53+
3. Save the link to the repository
54+
55+
56+
<figure markdown>
57+
<div class="center">
58+
<img src="../assets/figures/development/download.png" />
59+
</div>
60+
</figure>
61+
62+
You should now have the correct code for your project and a link that you can share in scripts or in papers. An example of what you might put in a script is given below.
63+
64+
65+
```matlab
66+
% code runs with SPM development version
67+
% https://github.com/spm/spm/tree/94924bf0bed4656fb4ef5945f98cb0cf74eb51df
68+
```

0 commit comments

Comments
 (0)