From 849fe4e22b359942350d7f583780482f1852e4bb Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Thu, 5 May 2022 14:46:02 +0530 Subject: README: Replace org mode with markdown. Markdown is a simpler format and easier to render to the web. In particular, this change is prompted by Gitea not handling image links correctly. * README.org: Replace with ... * README.md: ... this. --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..fdad92a --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +[![dump-genenetwork-database-tests CI +badge](https://ci.genenetwork.org/badge/dump-genenetwork-database-tests.svg)](https://ci.genenetwork.org/jobs/dump-genenetwork-database-tests) +[![dump-genenetwork-database CI +badge](https://ci.genenetwork.org/badge/dump-genenetwork-database.svg)](https://ci.genenetwork.org/jobs/dump-genenetwork-database) + +The GeneNetwork database is being migrated from a relational database to +a plain text and RDF database. This repository contains code to dump the +relational database to plain text. + +# Using + +Drop into a development environment with + +``` shell +$ guix shell +``` + +Describe the database connection parameters in a file *conn.scm* file as +shown below. Take care to replace the placeholders within angle brackets +with the appropriate values. + +``` scheme +((username . "") + (password . "") + (database . "") + (host . "") + (port . )) +``` + +Then, to dump the database to \~/data/dump, run + +``` shell +$ ./pre-inst-env ./dump.scm conn.scm ~/data/dump +``` + +Make sure there is enough free space! It\'s best to dump the database on +penguin2 where disk space and bandwidth are not significant constraints. + +# Contributing + +See bugs and tasks in BUGS.org. -- cgit v1.2.3