Skip to content

README.md

Latest commit

 

History

History
99 lines (76 loc) · 3.93 KB

README.md

File metadata and controls

99 lines (76 loc) · 3.93 KB
Raw

crsw-data-ingestion-tool

Command-line tool for depositing research files into the CRSW shared object storage (Ceph, S3-compatible, hosted by KCL eResearch). It builds the object key from the Centre's path convention, writes a sidecar metadata file per object, and uploads both via rclone.

Requirements

  • Python 3.8 or newer (standard library only — nothing to install)
  • rclone — installed, or the binary dropped in this folder
  • An rclone remote for the storage service. Add this to your rclone config (rclone config file shows where it lives; keys come from eResearch):
[ceph]
type = s3
provider = Ceph
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = https://OBJECT-STORE-ENDPOINT-FROM-ERESEARCH
  • The KCL VPN — the storage endpoint is not reachable without it.

Usage

python deposit.py FILE_OR_GLOB [FILE_OR_GLOB ...] [options]

  --strand rs2            skip strand prompt (rs1/rs2/rs3/rs4)
  --project csac          skip project prompt
  --domain quant          skip domain prompt (codes from the vocabulary)
  --state 2_final         skip state prompt (0_raw/1_interim/2_final)
  --sensitivity green     skip sensitivity prompt (green/amber)
  --dry-run               preview keys and sidecars, upload nothing
  --remote NAME           rclone remote (default: saved config, else ceph)
  --bucket NAME           target bucket (default: saved config, else crsw)
  --reconfigure           re-run the remote/bucket setup prompts
  --verbose               show raw rclone output on errors

Anything not supplied as a flag is prompted for. Prompts with a fixed set of answers show a numbered menu — type the number or the value, either works. A fully-flagged --dry-run is the way to check a deposit before committing to it, and the way to reproduce a problem when asking for support.

Files land at {strand}/{project}/{sensitivity}/{state}/{filename}, with a {filename}.meta.json sidecar next to each. Filenames are preserved exactly as deposited; if a name contains awkward characters the tool offers a correction but never applies one silently. After upload, both objects are verified to exist at the expected size before the deposit is reported done.

Red-classified data is refused — it belongs in the TRE, not shared storage.

Configuration

On first run the tool asks which rclone remote and bucket to use (picking the remote from a menu of those you already have) and saves the answer to %LOCALAPPDATA%\crsw-deposit\config.json (Windows) or ~/.config/crsw-deposit/config.json (macOS/Linux). Precedence is command-line flag → saved config → built-in default. Run with --reconfigure to change the saved values.

Subjects and domains vocabulary

Subject terms and data domains are validated against the shared vocabulary, fetched live so newly approved terms are available immediately. If the fetch fails (offline, VPN restrictions) the tool falls back to a cached copy, then to the bundled vocab.json, and says which one it used. The subject listing is shown, numbered, before you're asked — answer with numbers, terms, or a mix. Unknown terms are refused — propose additions via the vocabulary repository or your domain steward. Choosing a domain fills in its steward automatically.

Output

Colour is used sparingly (warnings yellow, errors red, success green) and never as the only signal. Set NO_COLOR=1 to disable it, FORCE_COLOR=1 to force it on; piped or redirected output is always plain.

Deposit log

Every successful deposit appends a line (timestamp, key, checksum, depositor) to deposits.log in %LOCALAPPDATA%\crsw-deposit\ (Windows) or ~/.cache/crsw-deposit/ (macOS/Linux).

Development

Run the tests with:

python -m unittest discover -s tests -v

The build spec is DEPOSIT_TOOL_SPEC.md, revised by DEPOSIT_TOOL_SPEC_r2.md (r2 supersedes where it speaks). Module boundaries and constraints are documented there and in CLAUDE.md.