====== Model Family Directory Structure ======
**✅ CONTENT MIGRATED TO GURU ON FEBRUARY 22, 2024**


Within the model account there needs to be a directory structure for the design diagrams and many temporary files created by running dimensional analysis on the diagrams.

The structure below is the recommended model family directory structure:

<code>
models/modelAcct/primaryData
models/modelAcct/V1/
                   cal
                      views
                      scenarios
                   data
                   informants
                   sim
                      views
                      scenarios

models/modelAcct/V2/
                   cal
                      views
                      scenarios
                   data
                   informants
                      textfiles
                   sim
                      views
                      scenarios


</code>
==== primaryData ====
This is where the external inputs to the model are stored.  It is at a higher level than the model version directories so the data can be easily shared between the versions.  

==== cal ====
The **cal** directory is where the calibration diagram is stored and all the files related to calibration are kept in sub directories.

The **views** folder holds all the views related to calibration.  These views load source data, do feedback for tracking on historic data, and produce display reports wrt the calibration.

The **scenarios** folder holds exported data from loaded models.  It is often useful to store the intermediate results as working through a calibration process so that if it has to be re-loaded not all the previous work needs to be repeated.  Usually the tracking scenario is compared to the source history scenario and the difference is exported into this directory with an import script for future use.

==== sim ====
The **sim ** directory is where the simulation diagram is stored and all the files related to simulation are kept in sub directories.

The **views** folder holds all the views related to simulation.  These views provide a way to setup the business as usual scenario as well as views for creating different parameters for creating alternate futures scenarios.

The **scenarios** folder holds exported data from loaded models.  It is often useful to store certain scenarios as differences from the baseline so they can be easily re-created in future loads.

==== informants ====
The **informants** directory should be created inside the version folder, the diagrams will write the informant files into this directory.  

When first creating informants in the diagram it is often helpful to load the element lists from a text file.  Any text file used for this purpose is usually kept in the **informant/textfiles** directory. 

==== data ====
This is create as a container where the sim and cal diagrams store temporary files related to the variables in the model.

===== Helpful script =====

The attached unix shell script creates these directories. {{:howtos:admin:mkmodeldirs.csh|}}
  * Make the version directory first and cd into it
<code>
mkdir V1
cd V1
</code>
  * Save the attached file in that directory 
  * Run the file
<code>
csh mkModelDirs.csh
</code>