diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..2c746540 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Changgang Li + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index ce9a6ab7..5c6554e5 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,44 @@ Simulation Toolkit for Electrical Power Systems + Maintainer: Changgang Li -Please go to http://steps.drli.group:380 for documentation. + +Please go to http://steps.drli.group:310 for documentation. How to build: -1) Select which LA solver is to be used +1) Select which Linear Algebra solver is to be used + Open STEPS.cbp and go to header/basic/sparse_matrix_define.h. Comment the solver you don't want to use. + For example, if you want to keep only c_sparse, comment out umfpack and klu. + Then go to source/basic/sparse_matrix_klu.cpp and umfpack.cpp, disable 'compile' and 'link' options of the two files. -2) Go compile the LS solver. + +2) Go compile the Linear Algebra solver. + For example, open csparse.cbp, and compile CSparse. The target should be 'static library' + 3) Go compile the CppTest. + Open cpptest.cbp, and compile CppTest. The target should be 'static library' + 4) Build STEPS + In the linker settings, you should include the above two static libraries libCSparse.a and libCpptest.a. + Then compile the STEPS. + 5) If you want to build a 64bit version, use 64 bit MinGW and select the X64 version compiler. If you want to compile a complete version, follow the steps: + 1) Compile BLAS as static library + 2) Compile UMFPACK as static library + 3) Compile CSparse as static library + 4) Compile CppTest as static library + 5) Compile STEPS as dynamic library or exectuable file. Include libUMFPACK.a, libBLAS.a, libCSparse.a, and libCpptest.a. Put libBLAS.a after libUMFPACK.a. When compiling in Windows, remove -no-pie and -lgfortran options and remove libKLU.a, libBLAS.a, libUMFPACK.a