Skip to content

Home_Overview

Max-Home-Tower edited this page Jul 1, 2020 · 1 revision

Code Organization

(Current as of: 2019-12-31)

Packages

Presently, the only package is +nigeLab; however, in the future, a +config package (or folder) may be added once a top-level nigeLab function is added as a wrapper to the graphical nigeLab interface. For the time-being, any graphics interfaces still have to be accessed by calls to the command line or by running a script.

This contains the nigeLab package. In order to use nigeLab in Matlab, you must first add whichever folder contains +nigeLab to the path (or navigate in the Matlab Editor Browser so that your Current Folder can "see" +nigeLab). Because it is a Matlab package, all classes and sub-packages must be referenced using 'dot' notation (e.g. blockObj = nigeLab.Block();). A high-level overview of nigeLab design concepts for developers can be found here.


Other

There are a few other things in the repository at this level:

dev

Folder that is ignored in .gitignore. If you are testing out nigeLab or using a nigelObj (superclass is a work-in-progress; for now this just denotes Block, Animal, or Tank objects) to develop code for nigeLab, this is a good place to put that data.

.gitignore

The current default .gitignore is set up to ignore files in nigeLab.setup.demo, as well as in dev. There is also a list of *.mat and *.rhs files (at least on MM local .gitignore) that probably needs to be updated.

Clone this wiki locally