Skip to content

Commit 8dcd8e7

Browse files
committed
Add /data/ directory for simulation results.
1 parent 920e6b0 commit 8dcd8e7

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@ core/*
1010
user/+*
1111
!user/+tutorials
1212

13-
# Ignore all files and folders in tutorials, except the readme
13+
# Ignore all files and folders in tutorials, except README
1414
user/+tutorials/*
1515
!user/+tutorials/README_TUTORIALS.md
1616

17+
# Ignore simulation results, excepct README
18+
data/*
19+
!data/README.md
20+
1721
# Ignore all files and folders in lib, except the readme file
1822
lib/*
1923
!lib/README_BOOTSTRAPPING.md

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ Downloaded from GITlab at <http://steps.lrt.mw.tum.de/>
66
Bootstrapping Repository
77
------------------------
88

9-
Basic repository with the framework for V-HAB / STEPS. Contains three directories:
9+
Basic repository with the framework for V-HAB / STEPS. Contains four directories:
1010

1111
* core: central, shared V-HAB framework.
1212
* lib: helper functions, pre/post processing, logging, GUI, date functions, … (TBD)
1313
* user: user-specific simulations
14+
* data: user-generated simulation results (e.g. logs, plots, spreadsheets)
1415

15-
The core and lib packages are managed, i.e. most likely no changes should be done or can be commited to the online repository. Wiki of the according projects will soon contain some help.
16+
The core and lib packages are managed, i.e. most likely no changes should be done or can be committed to the online repository. Wiki of the according projects will soon contain some help.
1617

1718
How to get started with git / GITlab
1819
------------------------------------
@@ -92,14 +93,14 @@ To view a repository, double-click on its entry in the SourceTree *Bookmarks* wi
9293
Getting Started Programming
9394
----------------
9495

95-
### Create your user folder ###
96-
97-
Once you have successfully cloned the bootstrapping project onto your hard drive, navigate to the `user` folder. There create a folder using the following naming scheme: `+username`. Your username is the first two letters of your last name and the first two letters of your first name. So if your name is Max Mustermann, your username would be `muma`.
98-
99-
### Check out the tutorials! ###
100-
101-
Inside the directory `user/+tutorials` you will find a few tutorials to get you started. Some of them also have read me files like the one you are reading right now, be sure to check them out. To run one of the tutorials, enter the following command into the MATLAB command window: For example the „simple_flow“ tutorial is `vhab.exec(’tutorials.simple_flow.setup’)`. Once the simulation has completed (you will see this by the outputs in the command window), you can plot the results of your simulation by entering `oLastSimObj.plot()` in the command window. Now you can play around with some of the parameters of the systems inside the tutorial and see what happens.
102-
96+
### Create your user folder ###
97+
98+
Once you have successfully cloned the bootstrapping project onto your hard drive, navigate to the `user` folder. There create a folder using the following naming scheme: `+username`. Your username is the first two letters of your last name and the first two letters of your first name. So if your name is Max Mustermann, your username would be `muma`.
99+
100+
### Check out the tutorials! ###
101+
102+
Inside the directory `user/+tutorials` you will find a few tutorials to get you started. Some of them also have read me files like the one you are reading right now, be sure to check them out. To run one of the tutorials, enter the following command into the MATLAB command window: For example the „simple_flow“ tutorial is `vhab.exec(’tutorials.simple_flow.setup’)`. Once the simulation has completed (you will see this by the outputs in the command window), you can plot the results of your simulation by entering `oLastSimObj.plot()` in the command window. Now you can play around with some of the parameters of the systems inside the tutorial and see what happens.
103+
103104
### How to update your local files ###
104105

105106
If you want to update your local working copy files to the current version, select the bootstrapping repository in SourceTree and press "pull". This should load all new or changed files onto your machine.

data/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This folder is intended for simulation results. No code or documentation shall be placed here (except explanation of results).

0 commit comments

Comments
 (0)