Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Hui committed Mar 3, 2023
1 parent 7dd4f1d commit 8de6ae9
Showing 1 changed file with 35 additions and 30 deletions.
65 changes: 35 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,22 @@ Welcome to the E4E Data Management Tool Suite.

This suite should be used to manage data in the field, duplicate data across multiple drives for redundancy, compiling and staging all data after a deployment to the E4E NAS, and final archiving and management of deployment data on the NAS.

There are four tools provided by this suite:
- `E4EDuplicator`
- `E4EDataWrangler`
- `E4ECommitter`
- `E4EArchiver`

Each of these also has a corresponding command line version:
- `E4EDuplicatorCli`
- `E4EDataWranglerCli`
- `E4ECommitterCli`
- `E4EArchiverCli`
These are the valid commands:
- `e4edm init_dataset --date date --project project --location location [--path path]`
- `e4edm init_mission --timestamp timestamp --device device --country country --region region --site site --name name [--message message]`
- `e4edm config parameter value`
- `e4edm status`
- `e4edm activate dataset [day mission]`
- `e4edm add files`
- `e4edm commit`
- `e4edm duplicate paths`
- `e4edm validate`
- `e4edm push destination`
- `e4edm zip`
- `e4edm unzip`
- `e4edm list`
- `e4edm prune`


## Development
1. Open `e4e-data-management.code-workspace` in VS Code
Expand All @@ -23,35 +28,35 @@ Each of these also has a corresponding command line version:
5. Create a new Python terminal
6. Run `python -m pip install -e .[dev]`

`e4edm init_dataset --date date --project project --location location [--path path]`
`e4edm init_mission --timestamp timestamp --device device --country country --region region --site site --name name [--message message]`
`e4edm config parameter value`
`e4edm status`
`e4edm activate dataset [day mission]`
`e4edm add files`
`e4edm commit`
`e4edm duplicate paths`
`e4edm validate`
`e4edm push destination`
`e4edm zip`
`e4edm unzip`
`e4edm list`
`e4edm prune`

# Developer Notes
The final dataset folder should have the following internal structure:
```
[YYYY].[MM].[PROJ].[GEN_LOCATION]/
ED-00/
[Data as defined by the project]
metadata.json
[Mission 1]/
[Data as defined by the project]
manifest.json
metadata.json
[Mission 2]/
[Data as defined by the project]
manifest.json
metadata.json
...
ED-01/
[Data as defined by the project]
metadata.json
[Mission 3]/
[Data as defined by the project]
manifest.json
metadata.json
[Mission 4]/
[Data as defined by the project]
manifest.json
metadata.json
...
...
.e4edm.pkl
readme.md/.docx
manifest.json
readme.md/.docx
```

`.e4edm.pkl` is a E4E Data Management Tool file - this is not part of the dataset, but should not be removed. This is to retain state for the E4E Data Management tool.
Expand Down

0 comments on commit 8de6ae9

Please sign in to comment.