ImageGrid/Archive/README.md

# Photo archive template directory

The contents of this are copied to each archive drive root.

```shell
$ cp -R ./media PATH_TO_ARCHIVE_DRIVE
```

The scripts are stored with the archive for generational compatibility,
both building and documenting the structure the archive was created with.


## Scripts

```
media
├── img
│   └── my
│       └── work
│           ├── sync-flash.sh
│           ├── process-archive.sh
│           ├── compress-archive.sh
│           └── update-exif.sh
└── tree.sh
```

### `sync-archive.sh`

Ingest media into the archive and prepare it for further steps in the 
workflow

This script can be run interactively:
```shell
$ ./sync-archive.sh
```

This will:
- Create the directory structure
  (see: [Archive directory structure](#archive-direcotry-structure))
- Copy and verify the contents of 1 or more external media
  to the archive directory
- Prepare the archive for further work via `process-archive.sh`
- Compress the archive via `compress-archive.sh`


### `process-archive.sh`

Process the syncronized data for use with [ImageGrid.Viewer]()

```shell
$ ./process-archive.sh [FLAGS] PATH
```

This will:
- Extract previews from RAW files
- Extract metadata
- Build index




### `compress-archive.sh`

Compress archived files.

```shell
$ ./compress-archive.sh [FLAGS] PATH
```

This is designed to selectively compress uncompressed raw files (Sony) achiving +/- 2x compression factor.

By default this uses filesystem compression, supporting ntfs (on windows) and btrfs transparent native compression, but can be configured to use various archiving formats.



### `update-exif.sh`

Update EXIF of output previews from corresponding .psd / RAW files.

```shell
$ ./update-exif.sh [FLAGS] PATH
```


### `tree.sh`

Generte and check arcive file list.

This provides a basic and fast way to check high level tree consistency
against mostly humn-error.



## Archive directory structure


```
media
├── img
│   ├── my
│   │   └── work
│   │       ├── - 20240310 - shoot directory (multi flash card)
│   │       │   ├── 20240310.001
│   │       │   │   ├── ...
│   │       │   │   └── preview (RAW)
│   │       │   ├── 20240310.002
│   │       │   │   ├── ...
│   │       │   │   └── preview (RAW)
│   │       │   ├── ...
│   │       │   └── preview (RAW)
│   │       ├── - 20240310.001 - shoot directory (single flash card)
│   │       │   ├── ...
│   │       │   └── preview (RAW)
│   │       ├── 20240310 - shoot directory (fully sorted)
│   │       │   └── ...
│   │       └── ...
│   └── others
│       └── ...
├── video
│   └── ...
├── ...
└── tree.sh
```

Index root directory (single source media)
```
<date>.<index> - <info>/
```

Index root (multiple source media)
```
<date> - <info>/
```

Each synchronised media is stored in:
```
<date> - <info>/<date>.<index>/
```




Leading `"-"` indicates a not fully sorted shoot. 

```
- <date> - <info>/
```

This is the default as created by `sync-flash.sh`, renaming (removing the leading `"- "`) should be done by the user.