UWB-Biocomputing / WorkBench

Software and data provenance management platform for simulations of dissociated cortical cultures.
https://uwb-biocomputing.github.io/WorkBench/
Apache License 2.0
1 stars 3 forks source link

Implement intermediate directory structure #92

Closed stevecl5 closed 3 years ago

stevecl5 commented 3 years ago

Linked to Issue #89

This issue describes the first set of changes to the Workbench directory structure.

Goals:

The intermediate directory structure is shown below.

Install Directory*

/usr/local/bin/Workbench/
├── lib/
└── GraphittiWorkbench.jar

* read-only, portable

Projects Directory

WorkbenchProjects/
├── artifacts/
├── BrainGridRepos/
└── projects/
    ├── sim1/
    │   ├── configfiles/
    │   │   ├── NList/
    │   │   │   ├── act.xml
    │   │   │   ├── inh.xml
    │   │   │   └── prb.xml
    │   │   └── sim1.xml
    │   ├── provenance/
    │   │   └── sim1.ttl
    │   ├── scripts/
    │   │   ├── sim1_script1.sh
    │   │   ├── sim1_v1_scriptStatus.txt
    │   │   ├── sim1_v1_SHA1Key.txt
    │   │   └── sim1_v1_simStatus.txt
    │   └── sim1.xml
    ├── sim2/
    └── UniversalProvenance.ttl

Simulations Directory

.workbench/simulations/
├── sim1/
│   ├── configfiles/
│   │   ├── NList/
│   │   │   ├── act.xml
│   │   │   ├── inh.xml
│   │   │   └── prb.xml
│   │   └── sim1.xml
│   ├── results/
│   │   └── sim1-out.xml 
│   ├── sim1_script1.sh
│   ├── sim1_v1_output.txt
│   ├── sim1_v1_scriptStatus.txt
│   ├── sim1_v1_SHA1Key.txt
│   └── sim1_v1_simStatus.txt
└── sim2/

Workbench Directory

.workbench/
├── logs/
│   ├── provOverhead.txt
│   ├── WD-log.0
│   └── WD-WorkbenchManager-log.0
└── user.json
stiber commented 3 years ago

Looks good overall. Some nitpicking:

It may be the case that the user defined name for these directories isn't yet implemented in the WB UI, so we'd have to have a fixed name right now, set up so it can be changed easily to a user defined one when the WB UI catches up.