| ... | ... | @@ -6,7 +6,7 @@ This guide takes you through the process of: |
|
|
|
- running toolkit scripts to validate the installation process
|
|
|
|
- setting up a folder hierarchy within the GFS that corresponds the requirements of your organisation
|
|
|
|
- running toolkit scripts to validate that this has been successful
|
|
|
|
- For those wishing to use the toolkit with Arkivum's Perpetua, a script is run to create an upload package that contains your own files and metadata
|
|
|
|
- For those wishing to use the toolkit with the Arkivum digital preservation platform, a script is run to create an upload package that contains your own files and metadata
|
|
|
|
|
|
|
|
The toolkit has been tested on the Windows operating system. It will probably work with a macOS or Linux operating system but it hasn't been tested on them. The installation instructions are for a Windows system.
|
|
|
|
|
| ... | ... | @@ -32,7 +32,7 @@ To test whether the installation of Python has been successful, open a command w |
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
|
|
|
Click on the "Source code (zip)" file for the v2.0.1 release from the [GitLab Repository release](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/releases/v2.0.1) and unzip it into a folder close to the root folder of a drive, renaming the extracted folder from "lse_digital_toolkit-v2.0.1" to "lse_digital_toolkit". The reason the path to the folder should be short is because the path forms a component of the command lines via which the scripts are executed, and some operating systems have a limit to the length of a command line.
|
|
|
|
Click on the "Source code (zip)" file for the v2.1.0 release from the [GitLab Repository release](https://git.lse.ac.uk/hub/lse_digital_toolkit/-/archive/v2.1.0/lse_digital_toolkit-v2.1.0.zip) and unzip it into a folder close to the root folder of a drive, renaming the extracted folder from "lse_digital_toolkit-v2.1.0" to "lse_digital_toolkit". The reason the path to the folder should be short is because the path forms a component of the command lines via which the scripts are executed, and some operating systems have a limit to the length of a command line.
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
| ... | ... | @@ -67,7 +67,7 @@ The next step is to run the script that validates that the project csv file has |
|
|
|
|
|
|
|
The instructions for executing each script can be found in the header information at the top of each script file. To read these instructions, open the script file using a text editor (such as Notepad).
|
|
|
|
|
|
|
|
The example command lines will be like those shown below. The command lines will have to be modified slightly, in accordance with wherever you have installed the toolkit and GFS on your device.
|
|
|
|
The example command lines will be like those shown below. The command lines will have to be modified slightly, in accordance with however you have installed the toolkit and GFS on your device.
|
|
|
|
|
|
|
|
Execute the script that validates that the project csv file.
|
|
|
|
|
| ... | ... | @@ -85,7 +85,7 @@ python H:\lse_digital_toolkit\gfs_validate_tranche_csv.py Z:\GFS\UKLSE\EX1\ZT01\ |
|
|
|
|
|
|
|
Note that the script creates a “logs” folder within the tranche number folder (folder 001), and that a log file has been created within the folder by the execution of the script.
|
|
|
|
|
|
|
|
The output in the command window after the script has been executed should be similar to that indicated in this screenshot:
|
|
|
|
The output in the command window, after the script has been executed, should be similar to that indicated in this screenshot:
|
|
|
|
|
|
|
|
|
|
|
|
|
| ... | ... | @@ -216,7 +216,7 @@ This section is not mandatory. |
|
|
|
|
|
|
|
Run the script “gfs_create_arkivum_upload.py” to create the upload package.
|
|
|
|
|
|
|
|
python H:\lse_digital_toolkit\gfs_create_arkivum_upload.py y y y "Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\001" pres_and_acc default pdf
|
|
|
|
python H:\lse_digital_toolkit\gfs_create_arkivum_upload.py y y y "Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\001" pres_and_acc default md5 pdf
|
|
|
|
|
|
|
|
Note that the "pres_and_acc" on the command line is appropriate when the zip file will be uploaded to the "preservation_and_access" datapool, the alternative "pres" is appropriate when the zip file will be uploaded to the "preservation" datapool.
|
|
|
|
|
| ... | ... | @@ -258,6 +258,8 @@ After some more experimentation with the toolkit scripts (the instructions for e |
|
|
|
|
|
|
|
If you upload to Arkivum's Perpetua, once you are confident that your version of the GFS is well founded, contact Arkivum Technical Support to ask them to configure your system so that upload files produced by the gfs_create_arkivum_upload.py script can be processed.
|
|
|
|
|
|
|
|
The [Workflows](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/wikis/LSE-Digital-Toolkit#workflows) section indicates how some scripts can be used in conjunction with others to achieve particular outcomes.
|
|
|
|
The [Workflows](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/wikis/LSE-Digital-Toolkit#workflows) section indicates how some scripts can be used in conjunction with others to achieve specific outcomes.
|
|
|
|
|
|
|
|
One of these outcomes would be to use the file fixity checking functionality.
|
|
|
|
|
|
|
|
[Return to documentation home page](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/wikis/LSE-Digital-Toolkit) |
|
|
\ No newline at end of file |
