Skip to content

Commit 3eae514

Browse files
Added directory structure information and some project info
1 parent 4888f32 commit 3eae514

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# JuliaHealthLLM
22

3-
This code base is using the [Julia Language](https://julialang.org/) and
4-
[DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)
5-
to make a reproducible scientific project named
6-
> JuliaHealthLLM
3+
A proof of concept exploration of using LLM technologies across the JuliaHealth ecosystem.
74

8-
It is authored by Jacob S. Zelko, Param Thakkar.
5+
## Initializing Project
96

107
To (locally) reproduce this project, do the following:
118

@@ -28,3 +25,43 @@ using DrWatson
2825
@quickactivate "JuliaHealthLLM"
2926
```
3027
which auto-activate the project and enable local path handling from DrWatson.
28+
29+
## Directory Layout
30+
31+
Here is how the layout of this project is made:
32+
33+
```
34+
│projectdir <- Project's main folder. It is initialized as a Git
35+
│ repository with a reasonable .gitignore file.
36+
37+
├── _research <- WIP scripts, code, notes, comments,
38+
│ | to-dos and anything in an alpha state.
39+
│ └── tmp <- Temporary data folder.
40+
41+
├── data <- **Immutable and add-only!**
42+
│ ├── sims <- Data resulting directly from simulations.
43+
│ ├── exp_pro <- Data from processing experiments.
44+
│ └── exp_raw <- Raw experimental data.
45+
46+
├── plots <- Self-explanatory.
47+
├── notebooks <- Jupyter, Weave or any other mixed media notebooks.
48+
49+
├── papers <- Scientific papers resulting from the project.
50+
51+
├── scripts <- Various scripts, e.g. simulations, plotting, analysis,
52+
│ │ The scripts use the `src` folder for their base code.
53+
│ └── intro.jl <- Simple file that uses DrWatson and uses its greeting.
54+
55+
├── src <- Source code for use in this project. Contains functions,
56+
│ structures and modules that are used throughout
57+
│ the project and in multiple scripts.
58+
59+
├── README.md <- Optional top-level README for anyone using this project.
60+
├── .gitignore <- by default ignores _research, data, plots, videos,
61+
│ notebooks and latex-compilation related files.
62+
63+
├── Manifest.toml <- Contains full list of exact package versions used currently.
64+
└── Project.toml <- Main project file, allows activation and installation.
65+
Includes DrWatson by default.
66+
```
67+

0 commit comments

Comments
 (0)