Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 3.37 KB

README.md

File metadata and controls

45 lines (37 loc) · 3.37 KB
Raw

Zoo Mapper

About

This python program is a resource to go along with ZooMonitor© and other animal data collection applications. ZooMapper creates plots for 2D and 3D datasets, allows for interactive viewing and filtering of data, and can perform calculations for distances between animals.

File Structure

  • /data: folder to contain data files, either as .xlsx or .csv
  • /src/main/resources: contains image assets
  • /src/main: python files
    • zoo.py: Main program file. Contains methods for handling imports, exporting distance calculations, and the spreadsheet view
    • heatmap.py: Handles methods for creating import configuration, and saving an import
    • heatmappage.py: Plotting of graphs, highlighting points, and real time distance calculating on graph
    • pages.py: Frames for the different pages of the application
    • error.py: provides error messages for error handling
  • /src/main/saves: contains save configurations of imports. Saves as .json files

Required packages

The following Python packages are used in this application and are all found in requirements.txt

  • matplotlib version 3.1.1
  • numpy version 1.16.5
  • pandas version 0.25.1
  • pillow version 6.2.0
  • scipy version 1.3.1
  • tkinter version 0.1.0
  • tksheet version 5.0.25
  • xlrd version 1.2.0

Setting up the program

First, you will need to install a Python version newer than 3.6. We reccoment installing python version 3.9.5 as this was the newest version during our development. The instructions on how to install Python 3.9.5 for your device can be found here.

For Windows

If you are using a Windows system, open up the command prompt (seach cmd in the serach bar). Start by cloning this repository by running git clone repo_link_here. Then do cd sezarc and press enter to move into the project directory. Here, execute the command pip install -r requirements.txt. This will install the required packages that were listed above. Now you are all set to get ready to run the application.

For Mac/Linux

If you are using a Mac or Linux system, open a unix shell. Start by cloning this repository by running git clone https://github.com/channum/Zoo-Mapper.git. Then do cd sezarc and press enter to move into the project directory. Here, execute the command pip install -r requirements.txt. This will install the required packages that were listed above. Now you are all set to get ready to run the application.

Running the Program

First, navigate from the main sezarc directory to the directory /src/main by running cd src/main. Then, simply execute python zoo.py.

ZooMapper Tutorials

We have a few tutorial videos that can help you learn how to use the application. Below are links to the different videos: