ANL-CEEESA/powersas.m
1
0
Fork 0
mirror of https://github.com/ANL-CEEESA/powersas.m.git synced 2025-12-08 02:48:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

First release of PowerSAS.m

Browse Source
This commit is contained in:
Rui Yao
2021-12-22 23:37:28 -06:00
commit 985517593c
168 changed files with 1023584 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/installation.md Normal file
View File

@@ -0,0 +1,22 @@
# Installation
### 1. System requirements
Matlab (7.1 or later) or GNU Octave (4.0.0 or later).
### 2. Installation
* Extract source code to a directory.
* Enter the directory in Matlab or GNU Octave.
* Execute command `setup`. You will see the following sub-directories:
* `/data`: Stores test system data, simulation settings data, etc.
* `/example`: Some examples of using PowerSAS.m.
* `/output`: Stores test result data.
* `/internal`: Internal functions of PowerSAS.m computation core.
* `/util`: Auxiliary functions including data I/O, plotting, data conversion, etc.
* `/logging`: Built-in logging system.
* `/doc`: Documentation.
### 3. Test
* Execute command `initpowersas` to initilize the environment, then execute `test_powersas` to run tests. You should expect all tests to pass.
### 4. Initialization
To initialize PowerSAS.m, add the main directory of PowerSAS.m to your Matlab or GNU Octave path and run the command `initpowersas`. This will ensure that all the functions of PowerSAS.m are added to the path and thus callable.