Skip to content

Commit d50730b

Browse files
committed
Release 0.5.18. Includes numerous documentation, script and config file tweaks.
1 parent d5a5a88 commit d50730b

File tree

58 files changed

+536
-440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+536
-440
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ annalist
66

77
A free-form web linked data notebook and prototyping tool - "Data management for little guys"
88

9-
Current status (2019-05-10): public prototype, released for evaluation and feedback, feature freeze for version 1 release. Deployable as web-facing service using Apache2 or nginx for HTTPS handling (proxying).
9+
Current status (2022-04-09): prototype software for evaluation and feedback, feature freeze for version 1 release. Deployable as web-facing service using Apache2 or nginx for HTTPS handling (proxying).
1010

1111
For information about the current release, please refer to the [V0.5 release notes](documents/release-notes/release-v0.5.md)
1212

1313
NOTE: most recent stable software release is on the Git `master` branch; current development work is on the `develop` branch.
1414

15-
Demo system home page
16-
---------------------
15+
Home page
16+
---------
1717

18-
For general information about Annalist, and demonstration system links, see the [Annalist demonstration system home page](http://annalist.net/).
18+
For general information about Annalist, and demonstration system links, see the [Annalist home page](http://annalist.net/).
1919

2020
Quick-start
2121
-----------
@@ -85,7 +85,7 @@ Acknowledgements
8585

8686
Ideas motivating the creation of Annalist arose from discussions with past colleagues in the Zoology department at Oxford University, particularly Dr David Shotton who led the BioImage project, and Dr Helen White-Cooper who patiently explained her processes and data handling needs as a genomic researcher.
8787

88-
David Flanders, formerly of JISC, provided encouragement and support for the development of software tools to support academic activities, and in particular raising the profile of engineering and management skills needed to create effective software tools for academics. A previous project, [Shuffl](https://code.google.com/p/shuffl/), conducted under a JISC Rapid Innovation program that he ran, trialled some early ideas that have contributed to the development of Annalist (since migrated to [GitHub](https://github.com/gklyne/shuffl/tree/master) and [GitHub wiki](https://github.com/gklyne/shuffl/blob/wiki/ProjectHome.md)).
88+
David Flanders, formerly of JISC, provided encouragement and support for the development of software tools to support academic activities, and in particular championing the need to create effective software tools for academics. A previous project, [Shuffl](https://code.google.com/p/shuffl/), conducted under a JISC Rapid Innovation program that he ran, trialled some early ideas that have contributed to the development of Annalist (since migrated to [GitHub](https://github.com/gklyne/shuffl/tree/master) and [GitHub wiki](https://github.com/gklyne/shuffl/blob/wiki/ProjectHome.md)).
8989

9090
More recently, work with the European [Wf4Ever project](http://www.wf4ever-project.org), EPSRC [Fusing Audio and Semantic Technologies (FAST)](http://www.semanticaudio.ac.uk) and Mellon [Cultures of Knowledge](http://www.culturesofknowledge.org) have provided valuable insights into the nature of tools needed to support publication of reproducible and re-usable research data. Numerous experiments and discussions with colleagues have informed many of the design ideas and choices that have gone in to Annalist.
9191

documents/TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ See also: https://www.divio.com/en/blog/documentation/
6262
NOTE, for creating python3 virtual environment, use something like this:
6363

6464
python3 -m venv anenv3
65-
source anenv3/bin/activcate
65+
source anenv3/bin/activate
6666
python -m pip install pip --upgrade
6767
python -m pip install --upgrade setuptools
6868

documents/getting-started.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,15 @@ In a working directory, and with Internet connection:
6060

6161
python3 -m venv anenv3
6262
source anenv3/bin/activate
63+
python -m pip install --upgrade pip
64+
python -m pip install --upgrade certifi
65+
python -m pip install --upgrade setuptools
66+
pip install annalist
67+
68+
Or, with Python 3.9:
69+
70+
/usr/local/bin/python3.9 -m venv --upgrade-deps anenv3
71+
source anenv3/bin/activate
6372
pip install annalist
6473

6574
## Check the software installation, and initialize site data

documents/installing-annalist.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,26 @@ The following assumes that software is installed under a directory called $WORKS
7272
cd $WORKSPACE
7373
python3 -m venv anenv3
7474
source anenv3/bin/activate
75-
pip install --upgrade pip
76-
pip install --upgrade certifi
75+
python -m pip install --upgrade pip
76+
python -m pip install --upgrade certifi
77+
python -m pip install --upgrade setuptools
78+
pip install annalist
79+
80+
Or, with Python 3.9:
81+
82+
cd $WORKSPACE
83+
/usr/local/bin/python3.9 -m venv --upgrade-deps anenv3
84+
source anenv3/bin/activate
85+
pip install annalist
86+
7787

7888
3. Install the software from PyPI:
7989

8090
pip install annalist
8191

82-
4. Alternatively, obtain a copy of the Annalist distribution kit, e.g. from [annalist.net](http://annalist.net/), and copy to a convenient location (e.g., $WORKSPACE/Annalist-0.5.16.tar.gz). Then install it thus:
92+
4. Alternatively, obtain a copy of the Annalist distribution kit, e.g. from [annalist.net](http://annalist.net/), and copy to a convenient location (e.g., $WORKSPACE/Annalist-0.5.18.tar.gz). Then install it thus:
8393

84-
pip install $WORKSPACE/Annalist-0.5.16.tar.gz
94+
pip install $WORKSPACE/Annalist-0.5.18.tar.gz
8595

8696
5. Finally, test the installed software:
8797

@@ -90,27 +100,29 @@ The following assumes that software is installed under a directory called $WORKS
90100
The output from this command should look something like this:
91101

92102
$ annalist-manager runtest
93-
INFO:annalist_site.settings.runtests:Annalist version 0.5.16 (test configuration)
103+
INFO:annalist_site.settings.runtests:Annalist version 0.5.18 (test configuration)
94104
INFO:annalist_site.settings.runtests:SETTINGS_MODULE: annalist_site.settings.runtests
95-
INFO:annalist_site.settings.runtests:BASE_DATA_DIR: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/sampledata/data
105+
INFO:annalist_site.settings.runtests:BASE_DATA_DIR: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/sampledata/data
96106
INFO:annalist_site.settings.runtests:CONFIG_BASE: /Users/graham/.annalist/
97-
INFO:annalist_site.settings.runtests:DJANGO_ROOT: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/django
98-
INFO:annalist_site.settings.runtests:SITE_CONFIG_DIR: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/annalist_site
99-
INFO:annalist_site.settings.runtests:SITE_SRC_ROOT: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root
107+
INFO:annalist_site.settings.runtests:DJANGO_ROOT: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/django
108+
INFO:annalist_site.settings.runtests:SITE_CONFIG_DIR: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/annalist_site
109+
INFO:annalist_site.settings.runtests:SITE_SRC_ROOT: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root
100110
INFO:annalist_site.settings.runtests:TEST_BASE_URI: http://test.example.com/testsite
101-
INFO:annalist_site.settings.runtests:DEFAULT_DB_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/sampledata/data/annalist_test/db.sqlite3
102-
INFO:annalist_site.settings.runtests:DATABASE_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/sampledata/data/annalist_test/db.sqlite3
103-
INFO:annalist_site.settings.runtests:STATICFILES_DIRS: ((u'', u'/Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/annalist/data/static'), (u'images', u'/Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/annalist/data/identity_providers/images'))
104-
INFO:annalist_site.settings.runtests:ANNALIST_LOG_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv2/lib/python2.7/site-packages/Annalist-0.5.16-py2.7.egg/annalist_root/annalist.log
111+
INFO:annalist_site.settings.runtests:DEFAULT_DB_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/sampledata/data/annalist_test/db.sqlite3
112+
INFO:annalist_site.settings.runtests:DATABASE_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/sampledata/data/annalist_test/db.sqlite3
113+
INFO:annalist_site.settings.runtests:STATICFILES_DIRS: (('', '/Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/annalist/data/static'), ('images', '/Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/annalist/data/identity_providers/images'))
114+
INFO:annalist_site.settings.runtests:ANNALIST_LOG_PATH: /Users/graham/workspace/github/gklyne/annalist/anenv3/lib/python3.9/site-packages/Annalist-0.5.18-py3.9.egg/annalist_root/annalist.log
115+
Found 820 test(s).
105116
Creating test database for alias 'default'...
106117
System check identified no issues (0 silenced).
107-
...............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
118+
....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
108119
----------------------------------------------------------------------
109-
Ran 815 tests in 444.847s
120+
Ran 820 tests in 193.291s
110121

111122
OK
112123
Destroying test database for alias 'default'...
113124

125+
114126
For first-time installations, the Annalist site data will need to be initialized: see section "Setting up an Annalist site" below.
115127

116128

documents/pages/index.html

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
<div id="topheader">
1616
<h1 id="title">
1717
<a href="#">annalist.net</a> -
18-
<a htref="//demo.annalist.net/annalist/">Annalist</a> demonstration system
19-
<span>0.5.16</span>
18+
<a href="//annalist.net/annalist/">Annalist</a> demonstration system
19+
<!--
20+
<a href="//demo.annalist.net/annalist/">Annalist</a> demonstration system
21+
-->
22+
<span>0.5.18</span>
2023
</h1>
2124
</div>
2225
<!-- navigation -->
@@ -36,7 +39,7 @@ <h1 id="title">
3639
<h1>Welcome to annalist.net</h1>
3740

3841
<p>
39-
<a href="//demo.annalist.net/annalist/">Annalist demo server</a> (release 0.5.16).
42+
<a href="//demo.annalist.net/annalist/">Annalist demo server</a> (release 0.5.18).
4043
</p>
4144

4245
<h2>Overview</h2>
@@ -208,8 +211,11 @@ <h3>Software download</h3>
208211

209212
<ul class="green">
210213
<li>
211-
<a href="software/Annalist-0.5.16.tar.gz">Annalist-0.5.16</a>:
212-
Downloadable software installation kit. Needs Python 2.7.15, <code>virtualenv</code> and <code>pip</code>. Install using <code>pip</code> into a newly created Python virtual environment. (Can also be used with Python 3.7 if dependencies are appropriately patched.)
214+
<a href="software/Annalist-0.5.18.tar.gz">Annalist-0.5.18</a>:
215+
Downloadable software installation kit. Needs Python 3.8 or 3.9, <code>virtualenv</code> and <code>pip</code>. Install using <code>pip</code> into a newly created Python virtual environment.
216+
</li>
217+
<li>
218+
<a href="software/Annalist-0.5.16.tar.gz">Annalist-0.5.16</a> (older release).
213219
</li>
214220
<li>
215221
<a href="software/Annalist-0.5.14.tar.gz">Annalist-0.5.14</a> (older release).

0 commit comments

Comments
 (0)