README.md

# ocfl-demos

This is a repository for scripts and demos for the  project [FAIR Simple Scalable Static Research Data Repository Demonstrator](https://www.eresearch.uts.edu.au/2019/06/07/ardc_ocfl.htm).

Some of the data is UTS-only but the scripts are available for re-use.

## Audience

This is for NodeJS developers at UTS, and other interested parties capable of coding in node-js and advanced problem solving.

## Conventions

This guide assumes that you are working in `~/working`.

## Installation

To install calcyte-js from git (because you need the test data):

-  Follow [the instructions](https://code.research.uts.edu.au/eresearch/CalcyteJS) - you do not need bagit, so that step can be skipped.

-  Get this repository and install it:

   `git clone https://code.research.uts.edu.au/eresearch/ocfl-demos.git ~/working`

   `cd  ~/working/ocfl-demos`

   `npm install .`


## Usage 
To make an OCFL repository from the calcyte examples:

-   `make sample  CALCYFY_PATH=~/working/calcyte.js/ REPO_PATH=~/working/ocfl-demo`

  That will:
  -  Generate an RO-Crate at `~/working/calcyte.js/test_data/sample`
  -  Create an OCFL repository at `~/working/ocfl-demo` if it does not already exist
  -  Deposit the RO-Crate into the repository

  NOTE:
  -  Subsequent runs will add new versions of the same crate to the repository.

To make all the example from calcyte:
-   `make all  CALCYFY_PATH=~/working/calcyte.js/ REPO_PATH=~/working/ocfl-demo`

This will:
-  Generate RO-Crates for 4 examples at `~/working/calcyte.js/test_data/`
-  Create an OCFL repository at `~/working/ocfl-demo` if it does not already exist
-  Deposit the RO-Crate into the repository
-  Generate an index file


## TODO 

## Add more examples such as Cameron Neylon's dataset

### Port legacy datasets from the UTS Research Data Repository

### Run with data downloaded from Research Data Australia

### Add in sample data from Omeka (Farms to freeways and Dharmae)