README.md

OMR Checker Grade exams fast and accurately using a scanner 🖨 or your phone 🤳.

TLDR; Jump to Getting Started.

🎯 Features

A full-fledged OMR checking software that can read and evaluate OMR sheets scanned at any angle and having any color. Support is also provided for a customisable marking scheme with section-wise marking, bonus questions, etc.

💯 Accurate - Currently nearly 100% accurate on good quality document scans; and about 90% accurate on mobile images.

💪🏿 Robust - Supports low resolution, xeroxed sheets. See Robustness for more.

⏩ Fast Current processing speed without any optimization is 200 OMRs/minute.

✅ Extensible - Easily apply to different OMR layouts, surveys, etc.

📊 Visually Rich Outputs - get insights to configure and debug easily.

🎈 Lightweight - Core code size is less than 500 KB(Samples excluded).

🏫 Large Scale - Already used on tens of thousands of OMRs at Technothlon.

👩🏿‍💻 Dev Friendly - Well documented repository based on python and openCV.

Devs can look at TODOs for live challenges. See more at Project Wiki.

For any help:

Code in action on images taken by scanner: 🔥

Code in action on images taken by a mobile phone: 🔥

Getting started

Operating System

Although windows is supported, Linux is recommended for a bug-free experience.

1. Install dependencies

Note: To get a copy button for below commands, use CodeCopy Chrome | CodeCopy Firefox.

python3 -m pip install --user --upgrade pip
python3 -m pip install --user opencv-python
python3 -m pip install --user opencv-contrib-python

More details on pip install openCV here.

Note: On a fresh computer some of the libraries may get missing in above pip install.

Install them using the following commands: Windows users may skip this step.

sudo apt-get install -y build-essential cmake unzip pkg-config
sudo apt-get install -y libjpeg-dev libpng-dev libtiff-dev
sudo apt-get install -y libavcodec-dev libavformat-dev libswscale-dev libv4l-dev
sudo apt-get install -y libatlas-base-dev gfortran

2. Clone the repo

git clone https://github.com/Udayraj123/OMRChecker

Install other requirements

cd OMRChecker/
python3 -m pip install --user -r requirements.txt

Note: If you face a distutils error, use the --ignore-installed flag

sudo python3 -m pip install --ignore-installed -r requirements.txt

3. Run the code

Running default sample

If you want to try out the default sample, you can directly run:

python3 main.py

Running other samples

1. Remove previous inputs:

   # remove permanently: 
   rm -rf inputs/*
   # or move to trash
   mv inputs/* ~/.trash  

2. Copy your new inputs. You can use sample data as shown below:

   # sample1 is the default sample
   cp -r ./samples/sample2/* inputs/

   Note: Change the number N in sampleN to see more examples
3. Run OMRChecker: python3 main.py --noMarkers See usage guide here.

Note: For subsequent runs, if you don't want the outputs to append to previous results- Make sure the outputs folder is clean : rm -rf outputs/.

Running it on your own OMR Sheets

1. Follow the User Guide to create your own Template Layout.
2. Open globals.py and play with the parameters (although most of them would need no change 😄)
3. Run the code with appropriate arguments.

💡 What can OMRChecker do for me?

Once you configure the OMR layout, just throw images of the sheets at the software; and you'll get back the graded responses in an excel sheet!

Images can be taken from various angles as shown below-

These images will be processed in the following manner:

*Note: This image is generated by the code itself!*

Finally a CSV file will also be generated containing all the responses and scoring

There are many visuals in the wiki. Check them out!

💡 Why is this software free?

Our Motto:

Don't reinvent the wheel, use good wheels to make great vehicles!

After seeing it work fabulously at large scale at Technothlon, we have decided to open source the code and roll out mobile based scanning as well. The feedback from you all will be extremely valuable in making this idea become successful.

Can I use this code in my work?

OMRChecker is completely open source and published under GPLv3 license which is just to give you a heads up to disclose usage of this software in your code.

OMRChecker can be forked and modified. You are encouraged to play with it and we would love to see your own projects in action!

Credits

A Huge thanks to : The creative master Adrian Rosebrock for his blog : https://pyimagesearch.com

The legendary Harrison aka sentdex for his video tutorials.

And the james bond of computer vision Satya Mallic for his blog: https://www.learnopencv.com

And many other rockstars without whom this project would never have completed.

Thank you!

License

Copyright © 2019 Udayraj Deshmukh
OMRChecker : Grade exams fast and accurately using a scanner 🖨 or your phone 🤳
This is free software, and you are welcome to redistribute it under certain conditions;

For more details see

Related Projects

Here's a sneak peak of the Android OMR Helper App(WIP):

Activity:

Discord Group:

Find OMRChecker on Product Hunt | Swyya | Hacker News

Help us reach 550 stars ⭐ to become #1 (Currently #4) on the "OMR" tag on github

To keep my 💡 brain juices flowing and create more such projects, ☕ Buy Me A Coffee

If this project saved you large costs on OMR Software licenses, or saved efforts to make one, or simply want to give me some credit:

Note: This project was possible due to Technothlon, a non-profit organization run by students of IIT Guwahati. All of the proceedings will be utilised for funding good initiatives in the future.