From 3e8a2261baccaecba321da792010cfafd07c1567 Mon Sep 17 00:00:00 2001
From: Amira Abdel-Rahman <amira-rahman@aucegypt.edu>
Date: Tue, 16 Mar 2021 16:27:08 -0400
Subject: [PATCH] small documentation change
---
02_Presentation/documentation/codeStructure.md | 6 ++++--
README.md | 6 ++++--
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/02_Presentation/documentation/codeStructure.md b/02_Presentation/documentation/codeStructure.md
index 4c70f55..3c86ca2 100644
--- a/02_Presentation/documentation/codeStructure.md
+++ b/02_Presentation/documentation/codeStructure.md
@@ -62,7 +62,7 @@
- contains all html and styling information
- **Julia**
- `MetaVoxels.jl` will attach all the external and internal libraries
- - `include` folder is the most important as it contains the latest julia libraries for the gpu simulation
+ - `include` folder is the most important as it contains the latest julia libraries for the cpu and gpu simulation
- `vector.jl`
- utils for vectors and quaternions
- `material.jl`
@@ -83,6 +83,8 @@
- plotting and getting data out for analysis
- `cuda_calls.jl`
- CUDA related calls
+ - **jupyter**
+ - contains example notebooks to run the simulation and visualize the results
- **json**
- folder containing structures that are precomputed (either geometry or fea)
- example of json `setup`:
@@ -226,7 +228,7 @@
- **lib**
- contains all external libraries used (javascript)
- **visualization**
- - Contains all 3D visualization and design code
+ - Contains all 3D visualization and drawing code
- `draw.js`
- where i call all the high level commands for drawing voxels and simulation
- `geometry.js`
diff --git a/README.md b/README.md
index b510e24..ddd9981 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@ Tools for the design and simulation of metavoxels (meta-material voxel lattice s
I am now using this gitlab project for documentation only, the code lives [here](https://gitlab.cba.mit.edu/amiraa/metavoxels-code) now.
<img src="02_Presentation/hierarchy.png" width="80%" /><br></br>
+<img src="02_Presentation/overall.gif" width="80%" /><br></br>
+
<!-- <img src="02_Presentation/simpleBeam.mp4" width="40%" /><br></br>
<img src="02_Presentation/hier.mp4" width="40%" /> <br></br>
<img src="02_Presentation/5BaseVoxel.gif" width="40%" /><br></br>
@@ -97,11 +99,11 @@ I am now using this gitlab project for documentation only, the code lives [here]
- [x] port the code to different project
- [ ] Merge metavoxel with dice stuff??
- [x] Debug code to use latest julia and CUDA pkg
- - [ ] clean the files and put app.js and app1.js and julia notebooks in folders
+ - [x] clean the files and put app.js and app1.js and julia notebooks in folders
### Documentation
- [x] get the video you created and add it instead of gifs
- [x] make sure the codec information is correct
-- [ ] Document cpu version and how to change the number of threads
+- [x] Document cpu version and how to change the number of threads
### Demos
- [ ] different kinds of voxels
- [x] add chiral voxel
--
GitLab