Difference between revisions of "Demystify"
Ross-spencer (talk | contribs) m (Ross-spencer moved page DROID Siegfried Sqlite Analysis Engine to Demystify: The name of the application is no longer 'DROID Siegfried Sqlite Analysis Engine') |
Ross-spencer (talk | contribs) (Record updates including previous name; demystify-lite additions; more user-experiences) |
||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
<!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. --> | <!-- Describe the what the tool does, focusing on it's digital preservation value. Keep it factual. --> | ||
| − | Now known as "Demystify" with thanks to Joshua Ng for the suggestion to rename it. Demystify is an engine for the analysis of [https://github.com/digital-preservation/droid DROID] CSV export files, [https://github.com/richardlehane/siegfried Siegfried] YAML export files, and Siegfried 'DROID compatible' output. The tool has three purposes, break the exports into their components and store them within a table in a SQLite database; create additional columns to augment the output where useful; and query the SQLite database, outputting results in a readable form useful for analysis by researchers and archivists within digital preservation departments in memory institutions. | + | Now known as "Demystify" (formerly 'DROID Siegfried Sqlite Analysis Engine') with thanks to Joshua Ng for the suggestion to rename it. Demystify is an engine for the analysis of [https://github.com/digital-preservation/droid DROID] CSV export files, [https://github.com/richardlehane/siegfried Siegfried] YAML export files, and Siegfried 'DROID compatible' output. The tool has three purposes, break the exports into their components and store them within a table in a SQLite database; create additional columns to augment the output where useful; and query the SQLite database, outputting results in a readable form useful for analysis by researchers and archivists within digital preservation departments in memory institutions. |
The tool provides archivist definitions for each of the sections output; these definitions are customizable. The tool also supports output of statistics about files that may require further triage or may not be appropriate for long-term preservation based on institutional rules, in the form of a blacklist. The tool also analyses file names and directory names for non-ascii characters, and also characteristics that may present problems cross-file-system based on known Microsoft rules: http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx | The tool provides archivist definitions for each of the sections output; these definitions are customizable. The tool also supports output of statistics about files that may require further triage or may not be appropriate for long-term preservation based on institutional rules, in the form of a blacklist. The tool also analyses file names and directory names for non-ascii characters, and also characteristics that may present problems cross-file-system based on known Microsoft rules: http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx | ||
The engine can be used to generate a list of file paths for files that may present digital preservation risks (Rogues) or files which on the surface i.e. via identification alone, look okay (Heroes) and these listings can be used in conjunction with [http://manpages.ubuntu.com/manpages/trusty/man1/rsync.1.html rsync] to isolate these sets from one-another to be more flexible to work with. | The engine can be used to generate a list of file paths for files that may present digital preservation risks (Rogues) or files which on the surface i.e. via identification alone, look okay (Heroes) and these listings can be used in conjunction with [http://manpages.ubuntu.com/manpages/trusty/man1/rsync.1.html rsync] to isolate these sets from one-another to be more flexible to work with. | ||
| + | |||
| + | === Demystify Lite === | ||
| + | |||
| + | [https://ross-spencer.github.io/demystify-lite/ Demystify Lite] provides a Pyscript/WASM implementation of Demystify's features and runs completely browser side for users with DROID or Siegfried reports that they would like to see analyzed. | ||
== User Experiences == | == User Experiences == | ||
| Line 22: | Line 26: | ||
**'''[2016-05-23]''' [http://openpreservation.org/blog/2016/05/23/whats-in-a-namespace-the-marriage-of-droid-and-siegfried-analysis/ The integration of Siegfried output for consistent and repeatable reporting.] | **'''[2016-05-23]''' [http://openpreservation.org/blog/2016/05/23/whats-in-a-namespace-the-marriage-of-droid-and-siegfried-analysis/ The integration of Siegfried output for consistent and repeatable reporting.] | ||
**'''[2016-05-24]''' [http://openpreservation.org/blog/2016/05/24/while-were-on-the-subject-a-few-more-points-of-interest-about-the-siegfrieddroid-analysis-tool/ Creating a multi-lingual consistent, digital preservation dialect and exploring alternative methods of format identification using Siegfried's capabilities.] | **'''[2016-05-24]''' [http://openpreservation.org/blog/2016/05/24/while-were-on-the-subject-a-few-more-points-of-interest-about-the-siegfrieddroid-analysis-tool/ Creating a multi-lingual consistent, digital preservation dialect and exploring alternative methods of format identification using Siegfried's capabilities.] | ||
| + | **'''[2022-05-0]''' [https://journal.code4lib.org/articles/16351 Fractal in detail: What information is in a file format identification report?] | ||
= Development Activity = | = Development Activity = | ||
Revision as of 07:08, 27 March 2024
Description
Now known as "Demystify" (formerly 'DROID Siegfried Sqlite Analysis Engine') with thanks to Joshua Ng for the suggestion to rename it. Demystify is an engine for the analysis of DROID CSV export files, Siegfried YAML export files, and Siegfried 'DROID compatible' output. The tool has three purposes, break the exports into their components and store them within a table in a SQLite database; create additional columns to augment the output where useful; and query the SQLite database, outputting results in a readable form useful for analysis by researchers and archivists within digital preservation departments in memory institutions.
The tool provides archivist definitions for each of the sections output; these definitions are customizable. The tool also supports output of statistics about files that may require further triage or may not be appropriate for long-term preservation based on institutional rules, in the form of a blacklist. The tool also analyses file names and directory names for non-ascii characters, and also characteristics that may present problems cross-file-system based on known Microsoft rules: http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
The engine can be used to generate a list of file paths for files that may present digital preservation risks (Rogues) or files which on the surface i.e. via identification alone, look okay (Heroes) and these listings can be used in conjunction with rsync to isolate these sets from one-another to be more flexible to work with.
Demystify Lite
Demystify Lite provides a Pyscript/WASM implementation of Demystify's features and runs completely browser side for users with DROID or Siegfried reports that they would like to see analyzed.
User Experiences
- Blog entries from the tool author, Ross Spencer:
- [2014-06-03] Describing the creation and purpose of the tool.
- [2015-08-25] Using the output of the tool to create a digital preservation rogues gallery.
- [2016-05-23] The integration of Siegfried output for consistent and repeatable reporting.
- [2016-05-24] Creating a multi-lingual consistent, digital preservation dialect and exploring alternative methods of format identification using Siegfried's capabilities.
- [2022-05-0] Fractal in detail: What information is in a file format identification report?
Development Activity
All development activity is visible on GitHub: http://github.com/ross-spencer/demystify/commits
Release Feed
Below the last 3 release feeds:
- 2025-12-17 20:32:22
- [tag:github.com,2008:Repository/15066530/3.0.0-rc.4 3.0.0-rc.4]
- by ross-spencer
- 2025-12-17 19:43:13
- [tag:github.com,2008:Repository/15066530/3.0.0-rc.3 3.0.0-rc.3]
- by ross-spencer
- 2025-12-17 19:39:38
- [tag:github.com,2008:Repository/15066530/2.1.0 2.1.0]
- by ross-spencer
Activity Feed
Below the last 5 commits:
- 2025-12-17 19:30:15
- [tag:github.com,2008:Grit::Commit/5808ca753a2b6cd504b54469b89583ba4dfaa9da Correct rogues logic]
- by ross-spencer https://github.com/ross-spencer
- 2025-12-17 18:30:26
- [tag:github.com,2008:Grit::Commit/fa99f8ef0f2e629d104e6568eb4944f3e9165b82 Remove lxml]
- by ross-spencer https://github.com/ross-spencer
- 2025-12-17 18:29:56
- [tag:github.com,2008:Grit::Commit/39287330b07ba573d6d94ace7f052f4e0b825d5d Revert "Update sqlitefid and pathlesstaken"]
- by ross-spencer https://github.com/ross-spencer
- 2025-12-17 18:29:29
- [tag:github.com,2008:Grit::Commit/fb2f415b0109d5a4165592ce2eccd656357aae73 Revert sqlitefid and pathlesstaken]
- by ross-spencer https://github.com/ross-spencer
- 2025-12-17 18:18:51
- [tag:github.com,2008:Grit::Commit/34b2f119a2eb11337d0bab54581069f70095838e Update workflow]
- by ross-spencer https://github.com/ross-spencer