Jan-Itor

Description

• Terminal app using FTXUI to preprocess single word responses
• Cleans and serializes single word responses
• Response fields may be of varying formats.
• Jan-Itor may be used to obtain one or more of the following:
  • The serial position (relative to a list of target words) of sub-items in a column of responses.
  • A format-standardized version of responses.
  • A format-standardized & corrected version of responses.
  • Unique words present in responses.

Building

• Runs on both windows and Unix based systems.
• Requires no external dependencies to be installed. The only things needed to build are:
  • C++ build tools.
  • Git (to download the repository)
  • CMake
  • Make (if on Unix) / Ninja(if on Windows).
  • FTXUI (automatically downloaded by CMake).

Linux instructions

git clone https://github.com/unsigned-enby/Jan-Itor.git
cd ./Jan-Itor
mkdir build && cd ./build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j$(nproc)

Windows

• While Jan-Itor can be natively built on Windows, you may find it preferable to use 'Windows Subsytem for Linux'. Your welcome to use either. While WSL will take (slightly) longer, and use (a moderate amount of) more disk space, it will leave you with a virtual Linux system installed (that you may even use to run GUI apps!)

WSL:

• First open up a Windows Terminal and type wsl --install and accept the requested permissions.
• After doing this, you will need to restart your computer.
• After rebooting, open the Terminal once again and type wsl --install (you will not need to reboot this time, this will just install the Ubuntu-Linux system itself).
• After it finishes installing, simply run WSL with the wsl command; you should now be inside your Linux (sub-)system
• Run these commands:

sudo apt update
sudo apt upgrade # Not strictly required but ultimately recomended
sudo apt install build-essentials cmake git

• Then simply follow the instructions for Linux!

Building natively on Windows:

• First open a Windows Terminal and run these commands:

#install the neccassary C++ libraries
winget install Microsoft.VisualStudio.2022.BuildTools --force --override "--wait --passive --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows11SDK.22000"
#installs the build tools
winget install Git.Git Ninja-build.Ninja cmake

• close and reopen the terminal
• In the drop down menu located on the tab bar, click Developer PowerShell for VS 2022

git clone https://github.com/unsigned-enby/Jan-Itor.git
cd .\Jan-Itor
mkdir build
cd .\build
cmake -GNinja -DCMAKE_BUILD_TYPE=Release ..
ninja -C .

Alternative to building(Windows only):

Optionally, you may download a statically compiled (i.e everything it needs to run is 'baked-in') version for Windows. The simplist method would be to move the zip archive to your desktop, unpack it, rightclick on the file and choose 'open in terminal' and then simply type .\Jan-Itor.exe and hit enter!

Limitations

• Only ascii characters are handled.
• Very large files (100MB+) will slow to a crawl. While the program may appear to freeze, given enough time, it will continue on.
• Overall I prioritized accuracy over efficiency. As such, certain parts could perform better. However, as indicated above, the size of the file has to be rather large(as far as text files go) for this to be an issue.

Future Direction

• Implement various statistical routines.

Bugs/Suggestions

I have done a fair amount of testing with this on both Linux and Windows. However, there are alot of edge cases the consider here. I would highly recommend spot checking the results. If you notice any bugs/errors, letting me know would be greatly appreciated(and I will fix it as soon as I am able). A detailed description and the original data would be ideal. But if the data is in some form confidential, how to replicate the issue will suffice. Just as well, Jan-Itor will output an error log (error.log) that would be helpful to include.

If you have any suggestions on how to improve the current utility, or on different utilities to add, I'm all ears!