Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


AnimalBase is a tool to keep track of the animal population in a lab. It consists of a mysql database backend to store subject-related information and a JavaFX-written graphical interface to view/edit/create entries in the database.

For more information visit the github pages.


  • Manage animal population in the lab.
  • Create and manage subjects.
  • Track the housing history.
  • Track treatment history.
  • Manage licenses and permits.
  • Export population status and animal use reports.

Development status

The project is under ongoing development and things will change. Nevertheless, it is in daily use in the lab and the basic functionality is implemented.

Getting Started

Requirements To run AnimalBase you need:


For installation of the mysql server on your platform please refer to the documentation on the mysql websites.

To set up the database download the "migration" scripts.

Let's assume you have the database server running on the local machine (localhost). Log into it with a user that has administrator privileges (e.g. the root user).

> mysql -h localhost -u root -p

The server will be asking for the user password. Once logged in create the animal_keeping database and grant all rights on it to the user:

mysql> CREATE DATABASE animal_keeping;
mysql> GRANT ALL ON `animal_keeping`.* TO `root`@`localhost` IDENTIFIED BY 'your_root_password';

Log out and setup the database by executing from the command line:

> mysql animal_keeping < 0001-initial.sql -h localhost -u root -p

Proceed likewise for all the other migration files in the order defined by their name. The migration scripts adjust the database layout to the current schema layout and performs data migration if needed.

Should you be updating the database it is advisable to backup your data before.

> mysqldump animal_keeping > my_database_dump.sql -h localhost -u root -p

To restore a backup you need to drop and re-create the database:

mysql> DROP DATABASE animal_keeping;
mysql> CREATE DATABASE animal_keeping;

Log out and restore the backup by:

> mysql animal_keeping < my_database_dump.sql -h localhost -u root -p
You can’t perform that action at this time.