Skip to content

Latest commit

 

History

History
86 lines (47 loc) · 2.86 KB

README.md

File metadata and controls

86 lines (47 loc) · 2.86 KB
Raw

Kumbh Mela (meta)data entry interface

This repository contains a simple webinterface for entering, storing and managing metadata for the Kumbh Mela experiment.

The interface is created using Django 1.9.4. The relational database management system SQLite is used, since it is 1) light-weight, 2) easy to back-up (the entire database resides in just one file), and 3) is portable.

Note that this repository is available under the MIT license.

For more information on the structure of the database and other details, have a look at the publicly available Google Docs repository.

Getting started

The code/scripts in this project are written in Python. We require Python 3 to be installed. First, install virtualenv (if you haven't already):

$ pip install virtualenv

Create a virtual environment called kumbhmela by typing in the main directory:

$ virtualenv -p python3 kumbhmela
$ source kumbhmela/bin/activate

You can now easily install all requirements by typing

$ pip install -r requirements.txt

Running the webinterface

Enter the virtual enviroment kumbhmela we created in the previous section:

$ source kumbhmela/bin/activate

and run

$ python manage.py runserver

You can access the site by opening your favorite browser and going to the address http://127.0.0.1:8000/.

Creating a back-up

In order to back-up the (meta)database, follow the following steps:

  • Go to the main directory of the repository and locate the file kumbhmela_db.sqlite3. This file contains all (meta)data.

  • Copy the file to a thumb drive (or mail it).

  • Make sure to make a note about the time of the back-up. Otherwise is might be hard to afterwards figure out which back-up was which.

Accessing the admin site

Normally you would not find a section on a website about how to access the admin site, especially not with the username and password explicitly written down. Since this site is not going to be online (it will only run locally in the server room), there is no danger to put this here:

username: kumbhmela password: pepernoten

By clicking http://127.0.0.1:8000/admin and filling in the username and password, you can access the admin part of the site.

How to change the database structure?

Go the dataentry/models.py for changing the models (i.e., tables) and their fields. After making the desired changes, type

$ python manage.py makemigrations 
$ python manage.py migrate

The database is now updated.

Additional information

For a description of relational database structure and the way how to explore and add data, see http://127.0.0.1:8000/#howto.

Contact

Louis Dijkstra

E-mail: louisdijkstra (at) gmail.com