| ... | ... | @@ -14,73 +14,34 @@ The toolkit has been tested on the Windows operating system. It will probably wo |
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
|
|
|
## 1.1 Check whether the PC/laptop already has Python installed by opening a command window and typing the following (put a space two hyphens prior to “version”):
|
|
|
|
1.1 Check whether the PC/laptop already has Python installed by opening a command window and typing the following (put a space plus two hyphens prior to “version”):
|
|
|
|
|
|
|
|
python –version
|
|
|
|
|
|
|
|
If the message returned is "Python 3.10.0" or later, this is a sufficiently advanced version that the user can jump to step 1.3. However, if the command is unrecognised, or an earlier version of Python is present, click [here](https://www.python.org/downloads/) and download the latest version applicable to Windows.
|
|
|
|
If the message returned is "Python 3.10.0" or a higher number, this is a sufficiently advanced version that the user can jump to step 2. However, if the command is unrecognised, or an earlier version of Python is present, click [here](https://www.python.org/downloads/) and download the latest version applicable to Windows.
|
|
|
|
|
|
|
|
## 1.2 Click on the downloaded file to install Python on your PC. IMPORTANT! When you see the dialogue box below during the installation procedure, tick the "Add Python <version no> to PATH" box.
|
|
|
|
1.2 Click on the downloaded file to install Python on your PC. IMPORTANT! When you see the dialogue box indicated below during the installation procedure, put a tick in the "Add Python <version no> to PATH" box.
|
|
|
|
|
|
|
|
If you forgot to tick the box during installation, or Python has already been installed without it having been ticked, follow the instructions given in this document [How_to_add_Python_to_PATH_manually.docx](uploads/40f39542559fcd537ef4bdc73c7df772/How_to_add_Python_to_PATH_manually.docx).
|
|
|
|
|
|
|
|
To test whether the installation of Perl has been successful, open a command window (type “cmd” in the field where it states “Type here to search” in the bottom-left of the desktop) and at the prompt in the command window that appears, type “python --version”. If the message returned is "Python 3.10.0” or a higher number, Python has been installed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Install “Perl Version 5.28” by clicking on [this](https://www.activestate.com/products/perl/downloads/) link (note: please do NOT click on the “Download Perl 5.32” button after clicking on the link).
|
|
|
|
|
|
|
|
Select the link “ActiveState Perl 5.28 for Windows” from the download icons in the middle of the page. (again, please do NOT click on the “Download Perl 5.32” button).
|
|
|
|
|
|
|
|
It is necessary to create an account with ActiveState to download the "Perl V5.28".
|
|
|
|
|
|
|
|
Download the relevant installation “.exe” file for your device, and run the executable file.
|
|
|
|
|
|
|
|
To test whether the installation of Perl has been successful, open a command window (type “cmd” in the field where it states “Type here to search” in the bottom-left of the desktop) and at the prompt in the command window that appears, type “perl -v” - it should report some text that begins “This is perl 5, version 28, subversion 1 (v5.28.1)”.
|
|
|
|
|
|
|
|
## 2. Install 7-Zip
|
|
|
|
|
|
|
|
This section is only mandatory for users that wish to use the scripts that create/process upload and download packages for Arkivum's Digital Preservation Platform (Perpetua).
|
|
|
|
|
|
|
|
Type "7-Zip" in the search-box on the desktop. If the "7-Zip File Manager App" appears, 7-Zip has already been installed.
|
|
|
|
|
|
|
|
If it has not already been installed, open [this link](https://www.7-zip.org/), Download the appropriate executable for your device from the “7-Zip 19.00 (2019-02-21) for Windows:” options. The 7-Zip executable will probably be installed by default at:
|
|
|
|
|
|
|
|
C:\Program Files\7-Zip\7z.exe
|
|
|
|
|
|
|
|
If this is not the path to the 7z.exe file, once the toolkit has been installed in step (3), it will be necessary to edit the toolkit scripts “gfs_create_arkivum_upload.pl” and "gfs_distribute_arkivum_export_to_tranche.pl" according to the instructions found there to change the path to the 7z.exe file, so that it matches the installation path.
|
|
|
|
|
|
|
|
It is advisable to keep the path to the 7z.exe file short because it takes up space on a command line, and the Windows operating system has a limit on the length of a command line.
|
|
|
|
|
|
|
|
## 3. Install the Toolkit
|
|
|
|
## 2. Install the Toolkit
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
|
|
|
Create a folder close to the root of a drive.
|
|
|
|
Click on the "Source code (zip)" file for the v2.0.0 release from the [GitLab Repository release](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/releases/v2.0.0) and unzip it into a folder close to the root folder of a drive. 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:
|
|
|
|
|
|
|
|
H:\LSE_TK_PERL\
|
|
|
|
|
|
|
|
Click on the "Source code (zip)" file for the v1.0.2 release from the [GitLab Repository release](https://git.lse.ac.uk/bywell/lse-digital-toolkit-perl-version/-/releases/v1.0.2) and unzip it into the folder. The reason the path to the folder should be short is because the path forms a component of the command lines by which the Perl scripts are executed, and some operating systems have a limit to the length of a command line.
|
|
|
|
|
|
|
|
If you installed 7-Zip, and the path to the executable file was different from:
|
|
|
|
|
|
|
|
C:\Program Files\7-Zip\7z.exe
|
|
|
|
|
|
|
|
Edit line 187 of the toolkit script “gfs_create_arkivum_upload.pl”, and line 109 of toolkit script "gfs_distribute_arkivum_export_to_tranche.pl" using a text editor (such as Notepad). Change the path listed there to match the installation path. Each backslash within the path should be doubled.
|
|
|
|
|
|
|
|
For example:
|
|
|
|
H:\lse_digital_toolkit\
|
|
|
|
|
|
|
|
C:\Program Files\7-Zip\7z.exe
|
|
|
|
or
|
|
|
|
|
|
|
|
Should be entered at line 187 as:
|
|
|
|
C:\Users\<name>\lse_digital_toolkit\
|
|
|
|
|
|
|
|
C:\\\Program Files\\\7-Zip\\\7z.ex
|
|
|
|
|
|
|
|
## 4. Install the example Generic Folder Structure (GFS)
|
|
|
|
## 3. Install the example Generic Folder Structure (GFS)
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -96,7 +57,7 @@ Z:\GFS\\* |
|
|
|
|
|
|
|
The "Example GFS" contains some digitised journal issues. It only contains a small number of asset files, just a subset of those that would normally be present. This is to limit the download size of the zip file. For the same reason, it contains no tif files (which would normally be the master files for such a digitisation project).
|
|
|
|
|
|
|
|
## 5. Run some scripts against the sample GFS to check that everything is working
|
|
|
|
## 4. Run some scripts against the sample GFS to check that everything is working
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -134,7 +95,7 @@ The output in the command window after the script has been executed should be si |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 6. Create a folder hierarchy for your own organisation
|
|
|
|
## 5. Create a folder hierarchy for your own organisation
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -154,7 +115,7 @@ Create a folder with the name of your code at the same level of the hierarchy as |
|
|
|
|
|
|
|
Copy the entire folder hierarchy and contents that exists below the “UKLSE” folder into your organisation code folder.
|
|
|
|
|
|
|
|
## 7. Modify the copied folder structure so that it corresponds to a department and project relevant to your organisation
|
|
|
|
## 6. Modify the copied folder structure so that it corresponds to a department and project relevant to your organisation
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -181,13 +142,13 @@ The project code should be four characters in length, the first two characters a |
|
|
|
Continuing with the same renaming logic, edit the equivalent of the file named
|
|
|
|
_XXXXX_YY1_ZZ01_project.csv_ that resides in the equivalent of the “_ZZ01_” folder, and change the content of the “isadg.title” and “isadg.repository” columns in row 2 to be appropriate for a tranche within your project. A tranche is a sub-component of a project. For example, a tranche could contain all the issues for a particular journal. The project could contain tranches for multiple journals.
|
|
|
|
|
|
|
|
## 8. Check that the project csv file validates correctly in the new hierarchy you have created for your organisation
|
|
|
|
## 7. Check that the project csv file validates correctly in the new hierarchy you have created for your organisation
|
|
|
|
|
|
|
|
Execute the script that validates your project csv file.
|
|
|
|
|
|
|
|
perl H:\LSE_TK_PERL\gfs_validate_project_csv.pl Z:\GFS\\\<organisation code>\\\<department code>\\\<project code> default
|
|
|
|
|
|
|
|
## 9. Create s new tranche folder structure that reflects your content
|
|
|
|
## 8. Create s new tranche folder structure that reflects your content
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -211,7 +172,7 @@ If it runs without error, you will observe that a folder structure has been crea |
|
|
|
|
|
|
|
If the script reports that the folder-type was not recognised, open the gfs_folder_type_list.csv file in a suitable spreadsheet editor (such as Excel), and insert a new row for each of the folder-types that were not recognised into the alphabetical listing. Enter values in both the "gfs.folderName" and "gfs.fileNameExtension" columns, and then try running the gfs_create_tranche_folder.pl script again.
|
|
|
|
|
|
|
|
## 10. Populate the new tranche folder with asset files
|
|
|
|
## 9. Populate the new tranche folder with asset files
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -219,7 +180,7 @@ In a production environment, the folders might be populated by a Digitisation Pr |
|
|
|
|
|
|
|
For the purposes of this exercise, manually copy some files from a collection of your own to the appropriate folder-types.
|
|
|
|
|
|
|
|
## 11. Validate that the folder structure has been correctly populated
|
|
|
|
## 10. Validate that the folder structure has been correctly populated
|
|
|
|
|
|
|
|
This section is mandatory.
|
|
|
|
|
| ... | ... | @@ -229,7 +190,7 @@ perl H:\LSE_TK_PERL\gfs_validate_tranche_folder.pl n Z:\GFS\\\<organisation code |
|
|
|
|
|
|
|
View the screen output or script log file to ensure that the outcome meets with expectations.
|
|
|
|
|
|
|
|
## 12. Run the script that renames the files so that they comply with the GFS File-naming Convention for this tranche
|
|
|
|
## 11. Run the script that renames the files so that they comply with the GFS File-naming Convention for this tranche
|
|
|
|
|
|
|
|
This section is not mandatory.
|
|
|
|
|
| ... | ... | @@ -239,7 +200,7 @@ perl H:\LSE_TK_PERL\gfs_rename_tranche_files.pl Z:\GFS\\\<organisation code>\\\< |
|
|
|
|
|
|
|
If that script runs with no errors, all the files in the specified folders will have been renamed.
|
|
|
|
|
|
|
|
## 13. Check that the file renaming was successful
|
|
|
|
## 12. Check that the file renaming was successful
|
|
|
|
|
|
|
|
This section is only mandatory if the instructions in section 11 were followed.
|
|
|
|
|
| ... | ... | @@ -247,7 +208,7 @@ Run the gfs_validate_tranche_folder.pl script again, but this time with the firs |
|
|
|
|
|
|
|
perl H:\LSE_TK_PERL\gfs_validate_tranche_folder.pl y Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\001 jpg text alto pdf
|
|
|
|
|
|
|
|
## 14. Create a package suitable for upload to Arkivum’s Digital Preservation Platform (Perpetua)
|
|
|
|
## 13. Create a package suitable for upload to Arkivum’s Digital Preservation Platform (Perpetua)
|
|
|
|
|
|
|
|
This section is not mandatory.
|
|
|
|
|
| ... | ... | @@ -289,13 +250,13 @@ A successful upload of this zip file will only occur if the content of the metad |
|
|
|
|
|
|
|
The composition of the metadata.csv file can be controlled by editing the “gfs_arkivum_column_header_info.csv” configuration file. Details of how to configure the toolkit can be found in the [Configuration](https://git.lse.ac.uk/bywell/lse-digital-toolkit-perl-version/-/wikis/Configuration) section.
|
|
|
|
|
|
|
|
## 15. Tidying up your GFS
|
|
|
|
## 14. Tidying up your GFS
|
|
|
|
|
|
|
|
This section is optional.
|
|
|
|
|
|
|
|
The “UKLSE” folder, and everything beneath it, can now be deleted, so that the GFS only contains folders that are relevant to your organisation.
|
|
|
|
|
|
|
|
## 16 . What next?
|
|
|
|
## 15 . What next?
|
|
|
|
|
|
|
|
After some more experimentation with the toolkit scripts (the instructions for each script can be found at the top by opening the scripts with a text editor such as Notepad), it would be appropriate to consult the [Configuration](https://git.lse.ac.uk/bywell/lse-digital-toolkit-perl-version/-/wikis/Configuration) section in order to decide how best to set up the GFS so that it meets the requirements of your organisation. You can then add more departments, projects and tranches as required.
|
|
|
|
|
| ... | ... | |
