Skip to content

Trove lists and tags

Current version: v1.0.0

Trove lists and tags are created by Trove users to organise and describe resources. The details of public lists and tags are available through the Trove API. The notebooks in this repository demonstrate how to harvest and analyse list and tag data.

See below for information on running these notebooks in a live computing environment. Or just take them for a spin using Binder.

Binder

Lists

Convert a Trove list into a CSV file

This notebook converts Trove lists into CSV files (spreadsheets). Separate CSV files are created for newspaper articles and works from Trove's other zones. You can also save the OCRd text, a PDF, and an image of each newspaper article.

Convert a Trove list into a CollectionBuilder exhibition

This notebook converts a Trove list into a series of files that can be uploaded to a CollectionBuilder-GH repository to create an instant exhibition.

Harvest summary data from Trove lists

Use the Trove API to harvest data about all public lists, then extract some summary data and explore a few different techniques to analyse the complete dataset.

Tags

Harvest public tags from Trove zones

This notebook uses the Trove API to assemble a dataset containing all public tags added to Trove.

Analyse public tags added to Trove

This notebook loads the complete dataset of Trove tags and explores some ways of analysing and visualising the tag data.

Data

Trove lists metadata

Harvested: 5 July 2022. CSV formatted file containing a complete harvest of metadata describing user-created Trove lists.

Trove public tags

Harvested: 6 July 2022. CSV formatted file containing a complete harvest of public tags added to Trove resources.

Trove tag counts

Harvested: 6 July 2022. CSV formatted file containing the total number of times each tag in Trove has been applied to resources.

Run these notebooks

There are a number of different ways to use these notebooks. Binder is quickest and easiest, but it doesn't save your data. I've listed the options below from easiest to most complicated (requiring more technical knowledge).

Using Binder

Launch on Binder

Click on the button above to launch the notebooks in this repository using the Binder service (it might take a little while to load). This is a free service, but note that sessions will close if you stop using the notebooks, and no data will be saved. Make sure you download any changed notebooks or harvested data that you want to save.

See the Using Binder section of the GLAM Workbench for more details.

Using Reclaim Cloud

Launch on Reclaim Cloud

Reclaim Cloud is a paid hosting service, aimed particularly at supported digital scholarship in hte humanities. Unlike Binder, the environments you create on Reclaim Cloud will save your data – even if you switch them off! To run this repository on Reclaim Cloud for the first time:

  • Create a Reclaim Cloud account and log in.
  • Click on the button above to start the installation process.
  • A dialogue box will ask you to set a password, this is used to limit access to your Jupyter installation.
  • Sit back and wait for the installation to complete!
  • Once the installation is finished click on the 'Open in Browser' button of your newly created environment (note that you might need to wait a few minutes before everything is ready).

See the Using Reclaim Cloud section GLAM Workbench for more details.

Using Docker

You can use Docker to run a pre-built computing environment on your own computer. It will set up everything you need to run the notebooks in this repository. This is free, but requires more technical knowledge – you'll have to install Docker on your computer, and be able to use the command line.

  • Install Docker Desktop.
  • Create a new directory for this repository and open it from the command line.
  • From the command line, run the following command:
    docker run -p 8888:8888 --name trove-lists -v "$PWD":/home/jovyan/work quay.io/glamworkbench/trove-lists repo2docker-entrypoint jupyter lab --ip 0.0.0.0 --NotebookApp.token='' --LabApp.default_url='/lab/tree/index.ipynb'
  • It will take a while to download and configure the Docker image. Once it's ready you'll see a message saying that Jupyter Notebook is running.
  • Point your web browser to http://127.0.0.1:8888

See the Using Docker section of the GLAM Workbench for more details.

Setting up on your own computer

If you know your way around the command line and are comfortable installing software, you might want to set up your own computer to run these notebooks.

Assuming you have recent versions of Python and Git installed, the steps might be something like:

  • Create a virtual environment, eg: python -m venv trove-lists
  • Open the new directory" cd trove-lists
  • Activate the environment source bin/activate
  • Clone the repository: git clone https://github.com/GLAM-Workbench/trove-lists.git notebooks
  • Open the new notebooks directory: cd notebooks
  • Install the necessary Python packages: pip install -r requirements.txt
  • Run Jupyter: jupyter lab

See the GLAM Workbench for more details.

Contributors

Cite as

Sherratt, Tim. (2023). GLAM-Workbench/trove-lists (version v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.7566856