EIS1600 project tools and utilities
Project description
EIS1600 Tools
Workflow
(so that we do not forget again...)
- Double-check text in the Google Spreadsheet; “tag” is as “double-checked” (Column PREPARED);
- These double-checked files must be converted to
*.EIS1600
format - The names of these files are then collected into
AUTOREPORT.md
under DOUBLE-CHECKED Files (XX) - ready for MIU. - After that these files can be disassembled into MIUs, to be sotred in the MIU repository.
Process
- Convert from mARkdown to EIS1600TMP with
convert_mARkdown_to_EIS1600
- Check EIS1600TMP
- Run
insert_uids
- Check again. If anything was changed in the EIS1600 file, run
update_uids
- Run
disassemble_into_miu_files
Installation
$ pip install eis1600
In case you have an older version installed, use
$ pip install --upgrade eis1600
Usage
Covert mARkdown to EIS1600 files
Converts mARkdown file to EIS1600TMP (without inserting UIDs).
The .EIS1600TMP file will be created next to the .mARkdown file (you can insert .inProcess or .completed files as well).
This command can be run from anywhere within the text repo - use auto complete (tab
) to get the correct path to the file.
Alternative: open command line from the folder which contains the file which shall be converted.
$ convert_mARkdown_to_EIS1600TMP <uri>.mARkdown
EIS1600TMP files do not contain UIDs yet, to insert UIDs run insert_uids on the .EIS1600TMP file.
This command can be run from anywhere within the text repo - use auto complete (tab
) to get the correct path to the file.
$ insert_uids <uri>.EIS1600TMP
Batch processing of mARkdown files
Use the -e
option to process all files from the EIS1600 repo.
$ convert_mARkdown_to_EIS1600 -e <EIS1600_repo>
$ insert_uids -e <EIS1600_repo>
To process all mARkdown files in a directory, give an input AND an output directory. Resulting .EIS1600TMP files are stored in the output directory.
$ convert_mARkdown_to_EIS1600 <input_dir> <output_dir>
$ insert_uids <input_dir> <output_dir>
Disassembling
Disassemble files into the MIU repo. MIU repo has to be next to TEXT repo. Must be run from the root of TEXT repo, this will disassemble all files from the AUTOREPORT.
$ disassemble_into_miu_files
Give the relative path to a file to disassemble a singe file.
$ disassemble_into_miu_files <uri>.EIS1600
Reassembling
Run inside MIU repo. Reassemble files into the TEXT repo, therefore, TEXT repo has to be next to MIU repo.
$ reassemble_from_miu_files <uri>.IDs
Use the -e
option to process all files from the MIU repo. Must be run from the root of MIU repo.
$ reassemble_from_miu_files -e <MIU_repo>
NER Annotation
NER annotation for persons, toponyms, misc and dates.
To annotate all MIU files of a text give the IDs file as argument.
Can be used with -p
option to run in parallel.
$ ner_annotate_mius <uri>.IDs
To annotate an individual MIU file, give MIU file as argument.
$ ner_annotate_mius <uri>/MIUs/<uri>.<UID>.EIS1600
Use the -e
option to process all files from the MIU repo. Can be used with -p
option for parallelization.
$ ner_annotate_mius -p -e <MIU_repo>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.