Skip to content

Commit

Permalink
Merge pull request #61 from NYPL/software_review
Browse files Browse the repository at this point in the history
Software review
  • Loading branch information
dreyjo authored Sep 11, 2023
2 parents ac363ec + 0c91789 commit af44495
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 294 deletions.
40 changes: 40 additions & 0 deletions _data/program.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name,desc,inst,conf,use,docs
7-zip,7-zip is used in the lab to compress evidence and cases generated in Forensic Toolkit. It is also occasionally used to unpack collection material that is not supported by FTK.,[Download 7-zip](https://www.7-zip.org/),
apple3rtr,Apple /// Ready-to-Run (apple3rtr) is a software bundle used for MAME Apple emulation. It has been used by Digital Archives staff to view Apple II files.,For detailed installation instructions visit the [apple3rtr github repo](https://github.com/datajerk/apple3rtr).,,,https://github.com/datajerk/apple3rtr
AWS, Amazon Web Services (AWS) is a cloud computing platform offered by Amazon. AWS S3 features are used to store copies of born-digital material both before and after the collection has been processed by archivists.,,,,https://docs.aws.amazon.com/
Bagger, Bagger is an applciation created by the U.S. Library of Congress to produce files packages following the Bagit specification. It has been used in the Digital Archives lab for transferring born-digital material.,,,,https://github.com/LibraryOfCongress/bagger
Bagit.py, Bagit.py is a command line tool used produce files packages following the Bagit specification, Check python version by entering ```python --version``` or ```python3 --version``` into terminal. Then install using pip by entering ```pip install bagit``` or ```pip3 install bagit```. Use the link below the main download on the VirtualBox download site to install the Extension Pack on your host.,,,https://github.com/LibraryOfCongress/bagit-python
CiderPress, CiderPress is a Windows utility for managing Apple II disk images. It has been used in the Digital Archives Lab for viewing Apple file formats.,,,,https://a2ciderpress.com
dbpoweramp, dbpoweramp is a program used in conjunction with [Iromlab](#Iromlab) for transferring born-digital material from optical media.,
dd, dd is a command line utility used in the Digital Archives Lab to create disk images of optical media. In most cases transfers are made of optical media instead of disk images.,,,,https://linux.die.net/man/1/dd
Disk Utility, Disk Utility is a MacOS utility for disk volume management. Disk Utility used by Digital Archives staff for mounting/unmounting remvable media.,,,enter ```list disk``` or ```list volume``` to confirm media is mounted.,https://support.apple.com/guide/disk-utility/welcome/mac
diskpart, diskpart is Windows command line utility for disk partitioning. diskpart is used by Digital Archives staff for confimring removable media are properly mounted.,,,,https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/diskpart
disktype, disktype is a command line tool used by Digital Archives staff for extracting filesystem metadata like sector format for floppy disks, For Mac OS:<br> In terminal use homebrew to install by entering ```brew install disktype```,, In terminal navigate to the directory containing floppy disk image(s) and enter ```disktype a/disk/image```.,https://disktype.sourceforge.net/doc/
DosBox, DosBox is an open-source emulator for the MS-DOS operating system. DosBox has been used by Digital Archives staff to view DOS executables and word processing files.,,,,https://www.dosbox.com/DOSBoxManual.html
DROID, DROID is file format identification tool developed by the UK National Archives.,,,,https://cdn.nationalarchives.gov.uk/documents/information-management/droid-user-guide.pdf
Emailchemy, Emailchemy has been used in the Digital Archives lab for migrating email fomats.,,,,https://www.weirdkid.com/products/emailchemy/doc/Emailchemy_User_Manual.pdf
ePADD, ePADD is an open-source program developed by Stanford University's Special Collections and University Archives. The software ha been used for appraisal and arrangement of email.,,,,https://github.com/ePADD/epadd/releases
Forensic Toolkit, Forensic Toolkit is a computer forensics software used in the Digital Archives Lab to appraise and arrange born-digital material.
FTK Imager, FTK Imager is a disk imaging program associated with Forensic Toolkit. The software has been used in the Digital Archives lab to image and extract files from digital carriers.,
gtar, Gtar is a command line program used on Digital Archives MacOS workstations to compress Kryoflux stream files., For MacOS: Install via Homebrew by entering ```brew install gnu-tar``` in terminal.,,,https://www.gnu.org/software/tar/manual/tar.html
HFS Explorer, HFS Explorer is a program usd to view HFS formatted disks on Windows operating systems.,,,,https://catacombae.org/hfsexplorer/
Iromlab, Iromlab is software for automated imaging of optical media using [Nimbie](#tools/nimbie) disc robots.,,,,https://catacombae.org/hfsexplorer/
IsoBuster, IsoBuster is data recovery software that has been used in the Digital Archives lab to image and extract files from optical media.,
Java, Java is a software package which has been a dependency for some Digital Archives tools like DROID and Bagger.,,, Check for the version of Java installed with commands ```which java``` or ```java -version``` in terminal on Mac or WSL on Windows.,
MediaInfo, MediaInfo is an open-source program for extracting technical information from media files. The program has been used in the Digital Archives Lab to extract metadata from born-digital video.,
Mediaconch, MediaConch is an open source software project developed by MediaArea and utilizing MediaInfo. It is used by Digital Archives staff to develop programatic policies for checking born-digital audiovisual material against preservation standards.,
Mini Vmac, Mini vMac is an emulator for running early Macintosh software.
openssl, OpenSSL is a software library used to ssh.,,,,https://www.openssl.org/docs
Oracle VM VirtualBox, Virtualbox is open soure virtualization software. It has been used by Digital Archives staff to run teh BitCurator environment as a virtual machine., Download and install the [current VirtualBox release and Extension Pack](https://www.virtualbox.org/wiki/Downloads).
pip, Pip is package management software used for installing and upgrading Python modules,,,Pip should be installed with python3. Call pip by entering ```pip``` or ```pip3``` in terminal or command line.,
Python3, Python3 is the latest version of the Python programming language, For Windows: Check for python versions by entering ```python --version``` on command line. Installers are avilable at python.org.<br> For MacOS: Check for python versions by entering ```python --version``` in terminal. Install your selected version of python with homebrew by entering ```brew install [email protected]```.,
QuickTime Player, QuickTime is used in teh Digital Archives Lab to appraise Mcintosh formatted born-digital video.,
QuickView Plus, QuickView Plus has been used in the Digital Archives Lab to view a range of legacy formats like word processing and photo formats.,
rclone,rclone is a command line tool for managing and moving files between remote and local storage locations,For detailed installation and configuration instructions [see our dedicated rclone page](rclone.html).,,,https://rclone.org/docs/
Sha1deep, Sha1deep is a command line tool for computing and cryptographic hashes. (M5deep | sha1deep | sha256deep are a set of programs to compute MD5 | SHA-1 | SHA-256 message digests on files.) Sha1deep is used by Digital Archives Staff to identify duplicate material across digital media in a collection by comparing checksums., For MacOS: Install via Homebrew by entering ```brew install m5deep```,,,https://linux.die.net/man/1/sha1deep
Sheepshaver, Sheepshaver is an Apple Macintosh emulator. It has been used in the Digital Archives Lab to view legacy Mac files.,
Siegfried, Siegfried is a command line file format identification tool. Siegfried is used in the Digital Archives Lab to identify and validate file formats. Siegfried output also includes checksums., For Windows: Download [the latest Siegfried binary](https://github.com/richardlehane/siegfried/releases/download/v1.10.1/siegfried_1-10-1_win64.zip).<br> For MacOS: Install via homebrew by entering ```brew install richardlehane/digipres/siegfried``` into terminal,Current installations of siegfried use the config file to store preferred command options. Enter ```sf -setconf -csv -hash sha1 -z``` in terminal to set the preferred command options., Enter ```sf PATH > MediaID``` in terminal to create a report of file formats. Enter ```sf -help``` for a complete list of sf commands.,https://www.itforarchivists.com/siegfried/
tree, tree is command line program for recursive directory listing and has been used in the Digital Archives Lab to identify contents of media including number of folders and files, For MacOS: Install via homebrew by entering ```brew install tree``` into terminal.,
VLC, VLC is an open source media player used by Digital Archives staff to view and appraise born-digital audio and video., Download [the latest release of VLC Media Player](https://www.videolan.org/vlc/).,
WSL, Windows Subsystem for Linux (WSL) is a Windows feature used to run Linux environments on Windows operating systems.
WinUAE, WinUAE is an Amiga emulator and has been used in the Digital Archives Lab to view Amiga files.,
5 changes: 5 additions & 0 deletions _data/working.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name,desc,use
kryofluxmove.sh,This bash script is used by Digital Archives staff to move floppy disk images transferred using kryoflux to folders with legacy CMS media IDs of the associated digital carrier.,
SIPdir.sh,This bash script is used by Digital Archives staff to create consecutive numbers of submission information packages for material transferred from digital carriers.,
report_ftk_extents.py,This python script transforms XML reports exported from FTK after Processing Archivists have completed bookmarking into JSON files for import into ASpace.,The script takes two arguments: ```-f``` or ```--file``` followed by the path to the XML report to be transformed and ```-o``` or ```--output``` followed by the path the destination directory for JSON output.
report_HDD_extents.py,This python script collects the extents of finding aid components created by a Processing Archivist when processing work is done at a workstation with a hard drive. The script then produces an extents JSON file for import into ASpace.,The script takes one argument: ```-d``` or ```--dir``` for the finding aid components directory on a hard drive.<br> Run the script following the syntax: ```python3 path/to/report_ftk_extents.py -d /path/to/collection/er/directory```
37 changes: 37 additions & 0 deletions tools/programs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Programs
layout: default
nav_order: 6
parent: Software
grand_parent: Tools
has_children: False
---

# Programs:

Programs are defined as any non-internally developed out-of-the-box software used in Digital Archives workflows. Many programs used by Digital Archives staff can be installed via Homebrew or by downloading installation files from the associated website. Programs requiring more intensive installation and configuration instructions have been given dedicated pages.

{% for tool in site.data.program %}

## {{tool.name}}:
{{tool.desc}}

{% if tool.docs %}
[{{tool.name}} Official Documentation]({{tool.docs}})
{% endif %}

{% if tool.inst%}
### Installing {{tool.name}}:
{{tool.inst}}
{% endif %}

{% if tool.conf%}
### Configuring {{tool.name}}:
{{tool.conf}}
{% endif %}

{% if tool.use%}
### Using {{tool.name}}:
{{tool.use}}
{% endif %}
{% endfor %}
9 changes: 5 additions & 4 deletions tools/rclone.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: Rclone
layout: default
nav_order: 1
nav_order: 8
parent: Software
grand_parent: Tools
has_children: False
---

# Using Rclone:
# Rclone:
[*Rclone*](https://rclone.org/) is a command line tool for managing files on cloud storage, and is one tool used by Digital Archives for moving files between Digital Archives workstations, Google Shared Drives for Divisions, and long term storage. This page lists instructions for installing and configuring rclone.

## Installing Rclone:
Expand Down Expand Up @@ -38,9 +39,9 @@ Once installed, you must configure Rclone which involves setting the remote loca

- rclone will provide a list of scopes of access ranging from full access to all files to read-only access to file metadata. For our purposes enter the number corresponding to full access to all files.

- Rclone asks for a root folder id, this is optional and you can enter to select enter to choose default.
- Rclone asks for a root folder id, this is optional and you can select enter to choose default.

- Rclone asks for service account credentials, this is optional and you can enter to select enter to choose default.
- Rclone asks for service account credentials, this is optional and you can select enter to choose default.

- Rclone asks you to edit advanced configuration, select “n” for No. Follow up prompt asks if you would like to use auto configuration, enter “y” for Yes.

Expand Down
Loading

0 comments on commit af44495

Please sign in to comment.