Free-form web data notebook - "Data management for little guys"
PostScript Python CSS HTML TeX Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
documents Master branch updated to V0.1.36 Feb 13, 2017
presentations Add copy of slides used at #odcamp 3 May 14, 2016
spike Added very simple example of reading JSON-LD (cobbled from previous e… May 24, 2016
src
.gitignore Updating site data to use type qualified render type and value mode. May 10, 2016
INTRO.md
LICENCE.txt Added very simple example of reading JSON-LD (cobbled from previous e… May 24, 2016
README.md
readme-to-master.sh

README.md

annalist

DOI

A free-form web data notebook - "Data management for little guys"

_Current status (2016-06-12): public prototype, released for evaluation and feedback, approachiong feature freeze for a version 1 release.

For information about the current release, please refer to the V0.1 release notes

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

Demo system home page

For general information about Annalist, and demonstration system links, see the Annalist demonstration system home page.

Quick-start

See Getting started with Annalist.

There's also an on-line demonstration server - log in with a Gogle account to try creating or modifying data.

Installation

See Installing and setting up Annalist, and Configuring Annalist to use OpenID Connect.

Using Annalist

See the Guide to using Annalist

There are also a number of demonstration screencast videos, and accompanying scripts, which can be found at demonstration/evaluation scripts page.

Goals

A Linked Data Notebook, supporting collection, organization and sharing of structured and semi-structured data. The name "annalist" derives from "a person who writes annals".

  • Easy data: out-of-box data acquisition, modification and organization of small data records.
  • Flexible data: new record types and fields can be added as-required.
  • Sharable data: use textual, easy to read file formats that can be shared by web, email, file transfer, version management system, memory stick, etc.
  • Remixable data: records that can be first class participants in a wider ecosystem of linked data, with links in and links out.

In Annalist, I hope to create a generic data notebook which can be used for diverse purposes, in which I have been motivated by the needs of small academic research groups, and my own past experiences running a small business. I want to deliver a self-hostable, web-based tool that will, "out-of-box", allow collection of web accessible, linked data without prior design of its structure. I aim to allow structure in data to be developed as needs arise. Some of my ideas for this are drawn from pre-web PC tools (e.g. WordPerfect Notebook and Blackwell Idealist) which used simple text based file formats to drive flexible, small-scale databases. I find these products occupied a sweet spot that hasn't since been matched by any web-based software of which I'm aware.

Annalist is a work-in-progress, but I'm committed to open development throughout, so you can see all the technical work and notes to date here. It should be possible for a technically competent person to install and run the software, and get an indication of the direction I'm going. Annalist software is available as source code from github, a Python installation package from PyPI, and a Docker container.

As of August 2015, the basic data entry, form generation and configuration logic is working and it is possible to create simple collections of data, supporting a limited range of data types including imported and linked images and audio files. Missing core functionality intended for the initial release is generation of JSON-LD contexts for full linked data support. Also intended for the initial release are usability improvements, notably in the area of simplifying the creation of some common data patterns (such as linked type, view and list definitions for new record types).

Note that all the active development takes place on the "develop" branch. Tested versions are periodically merged to the default-visible 'master' branch. In due course, I plan to follow a "gitflow"-inspired working style that uses the "master" branch for released, tested software.

Status

The release notes give an summary of the current released state of the software.

Details of current feature development and status are available in the TODO list and GitHub issues.

Plans for future features and developments are sketched in the Development roadmap.

Feedback

Feedback can be provided via annalist-discuss forum or github issue tracker.

Development

Active development is taking place on the "develop" branch in GitHub - see https://github.com/gklyne/annalist/tree/develop

Acknowledgements

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.

David Flanders, formerly of JISC and now at University of Melbourne, 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, conducted under a JISC Rapid Innovation program that he ran, provided many technical and management lessons that have contributed to the development of Annalist.

More recently, work in the European Wf4Ever project, which explored the use of Research Objects to capture details of scientific method along with experimental data, raised many questions about the nature of tools needed to support publication of reproducible and re-usable research data. The numerous discussions and experiments have informed many of the design ideas and choices that have gone in to Annalist.