Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resources and database backup pages #124

Merged
merged 14 commits into from
Oct 14, 2024
22 changes: 21 additions & 1 deletion docs/source/admin/backup.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
Database backups
===============

...
The current process for backing up the Seshat database is as follows:

1. ssh into the server hosting the database e.g. `seshat-db.com` (see `websites <websites.rst>`_):

.. code-block:: bash

ssh user@server

2. Create a dumpfile backup of the PostgreSQL database, where `<seshat_db_name>` is the name of the database and `<date>` is the current date:

.. code-block:: bash

pg_dump -U postgres -d <seshat_db_name> > backup_<date>.dump

3. Download the dumpfile to your local machine:

.. code-block:: bash

scp user@server:/path/to/backup_<date>.dump /path/to/backup_<date>.dump

4. Upload the dumpfile to this `google drive folder <https://drive.google.com/drive/folders/1c5djM48ve91t84Ug4a8JksSC0p4J-eav?usp=sharing>`_.
2 changes: 2 additions & 0 deletions docs/source/expert/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Seshat Expert

This page includes help for our Seshat Experts: collaborators with the necessary expertise and permission to approve or reject changes to the Seshat data.

A list of experts is maintained on `our project info site <https://seshatdatabank.info/seshat-about-us/contributor-database>`_.


Creating a login on the Seshat website
---------------------------------------
Expand Down
15 changes: 12 additions & 3 deletions docs/source/researcher/datasets.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
Seshat datasets
===============

Data downloads
--------------
Data downloads (snapshots)
--------------------------

A list of datasets associated with the Seshat project and download links is maintained on the Seshat website at `seshat-db.com/downloads_page <https://seshat-db.com/downloads_page>`_.

These datasets are available for download in (typically) CSV format, and are the data used for research in associated academic publications.

Data cleaning code
-----------------

Here we list the code repositories that can reproduce the methodology used to generate the data downloads.
This code includes R and Python scripts for cleaning and processing the raw data.
In some cases, this involves pulling data from the Seshat API, meaning the datasets can be updated with the latest data from the Seshat database.


Making your dataset available to others
---------------------------------------
---------------------------------------

...
55 changes: 45 additions & 10 deletions docs/source/resources.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,61 @@
List of Seshat project resources
===============================
Project resources: where to find them
=========================================================

This page provides a list of resources related to the Seshat project, what they are and where to find them.
This includes publications, code repositories, datasets, websites and shared drives.

Papers
-----
Seshat websites explained
-------------------------

1. `seshat-db.com <https://seshat-db.com>`_ is the Seshat data website.

- Here you can log in as an admin, researcher, Seshat expert or public user to access Seshat data via the website or API.

- This site is managed by the Seshat Databank Admins; primarily Majid Benam. See the `team <team.rst>`_ page for more info.

2. `seshatdata.com <https://seshatdata.com>`_ is a test website which looks and behaves like the Seshat data website, but is used for testing new features before they are deployed to the main website.

3. `seshatdatabank.info <https://seshatdatabank.info>`_ is the project information website.

- This provides external facing information about the Seshat project, its goals, and the team behind it.

- This site is managed by Elizabeth Hempstead at the University of Oxford. Contact Pieter Francois to make changes to this site. See the `team <team.rst>`_ page for more info.


Academic publications
---------------------

A full list of academic publications associated with the project is available at `seshatdatabank.info/academic-publications <https://seshatdatabank.info/academic-publications>`_.

GitHub
------

The Seshat project has it's own organisation on GitHub at `github.com/Seshat-Global-History-Databank <https://github.com/Seshat-Global-History-Databank>`_.
Here you can find public repositories for the Seshat website and documenatation, the Seshat API Python package and the Cliopatria dataset.

Zenodo
------
There is a second GitHub organisation at `github.com/seshatdb <https://github.com/seshatdb>`_ which contains some repositories containing data and/or scripts for generating data for Seshat publications and data downloads (see below).

.. note::

- For more information on the using Seshat website codbase, see the `Seshat Databank Admin <admin/index.rst>`_ pages.
- For more information on using the Seshat API python package and the Cliopatria dataset, see the `Researcher <researcher/index.rst>`_ pages.


Websites
--------
Data downloads & Zenodo
-----------------------

Navigate to the `datasets <researcher/datasets.rst>`_ page for a list of datasets associated with the Seshat project and download links.

Codebooks
---------
There is not currently a Zenodo community for Seshat, but clicking through to those datasets will reveal Zenodo pages for some of the datasets.

Methods and codebook
--------------------

The `project information website <https://seshatdatabank.info/methods/world-sample-30>`_ contains information on the methods used to collect and encode data for the Seshat Global History Databank.

Shared drives
-------------

...

See the `backup <admin/backup.rst>`_ page for the shared drive used to store backups of the Seshat database.
Loading