Skip to content

Commit

Permalink
Improved readme and install
Browse files Browse the repository at this point in the history
  • Loading branch information
Anastasia Volkova committed Nov 1, 2019
1 parent 363c5a8 commit b90253a
Show file tree
Hide file tree
Showing 16 changed files with 1,932 additions and 1,434 deletions.
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Anastasia Volkova
anastasia.volkova@lip6.fr
anastasia.volkova@univ-nantes.fr

Christoph Lauter
3 changes: 3 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

WCPG library provides functions for a reliable evaluation of the Worst-Case Peak Gain matrix of a LTI filter.

In order to compile the software you will need the following packages
Expand Down Expand Up @@ -33,6 +34,8 @@ Please use

to get an overview over the different switches.

Known problem: have to ensure that /usr/local/include is in the $CFLAGS to find f2c.h

The WCPG library can be installed with command

make install
Expand Down
53 changes: 7 additions & 46 deletions README
Original file line number Diff line number Diff line change
@@ -1,51 +1,12 @@
WCPG library provides functions for a reliable evaluation of the Worst-Case Peak Gain matrix of a LTI filter.
====
WCPG
====

In order to compile the software you will need the following packages
installed:
WCPG library provides functions for a reliable evaluation of the Worst-Case Peak Gain matrix of a discrete-time LTI filter.

- gcc
- g++
- gmp
- mpfr
- mpfi
- f2c
- blas (install dev version in aperture)
- clapack (install dev version in aperture)
- libtool
(See the associated article https://hal.archives-ouvertes.fr/hal-01083879)

In order to configure, use the shell script file autogen.sh by invoking it using the
following command:

sh autogen
A minimal python wrapper is provided (and used in the FiXiF project)

Then, in order to compile, use the makefile by invoking it using the
following command:

./configure
make

The configure script coming with this distribution of WCPG supports
several --with-*** switches. These switches, as usual, enable the libraries
WCPG depends on to be installed in non-standard directories.
Please use

./configure --help

to get an overview over the different switches.

The WCPG library can be installed with command

make install

An example of a program, which uses libwcpg is build instantly with the library and can be invoked using
a test program which is located in TestProgram using following interface:

./testProgram filename.txt precision

where precision is indicated in format 1e-X.

For example,

cd exampleProgram & ./exampleProgram examples/eigen_example.txt 1e-45

After installation, library WCPG can be linked using -lwcpg.
See INSTALL for installation instructions
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
====
WCPG
===
====

WCPG library provides functions for a reliable evaluation of the Worst-Case Peak Gain matrix of a discrete-time LTI filter.

Expand Down
2 changes: 1 addition & 1 deletion TestProgram/testProgram
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ func_exec_program ()

if test -f "$progdir/$program"; then
# Add our own library path to DYLD_LIBRARY_PATH
DYLD_LIBRARY_PATH="/Users/thib/work/soft/FiXiF/WCPG/WCPG/.libs:$DYLD_LIBRARY_PATH"
DYLD_LIBRARY_PATH="/Users/avolkova/Research/Projects/fixif_toolbox/WCPG/WCPG/.libs:$DYLD_LIBRARY_PATH"

# Some systems cannot cope with colon-terminated DYLD_LIBRARY_PATH
# The second colon is a workaround for a bug in BeOS R4 sed
Expand Down
293 changes: 166 additions & 127 deletions WCPG/.deps/libwcpg_la-aux_funcs.Plo

Large diffs are not rendered by default.

310 changes: 182 additions & 128 deletions WCPG/.deps/libwcpg_la-clapack_functions_config.Plo

Large diffs are not rendered by default.

310 changes: 181 additions & 129 deletions WCPG/.deps/libwcpg_la-clapack_linalg.Plo

Large diffs are not rendered by default.

357 changes: 211 additions & 146 deletions WCPG/.deps/libwcpg_la-glue_conversions.Plo

Large diffs are not rendered by default.

357 changes: 210 additions & 147 deletions WCPG/.deps/libwcpg_la-inclusion_verif.Plo

Large diffs are not rendered by default.

351 changes: 205 additions & 146 deletions WCPG/.deps/libwcpg_la-mpfi_matrix.Plo

Large diffs are not rendered by default.

335 changes: 188 additions & 147 deletions WCPG/.deps/libwcpg_la-mpfr_eigendecomposition.Plo

Large diffs are not rendered by default.

314 changes: 184 additions & 130 deletions WCPG/.deps/libwcpg_la-mpfr_linalg.Plo

Large diffs are not rendered by default.

294 changes: 167 additions & 127 deletions WCPG/.deps/libwcpg_la-mpfr_matrix.Plo

Large diffs are not rendered by default.

381 changes: 224 additions & 157 deletions WCPG/.deps/libwcpg_la-wcpg.Plo

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion WCPG/.libs/libwcpg.lai
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ old_library='libwcpg.a'
inherited_linker_flags=' '

# Libraries that this one depends upon.
dependency_libs=' -lm -llapack -lblas -lmpfi -lmpfr -lgmp'
dependency_libs=' -lm -llapacke -lblas -L/usr/local/opt/openblas/lib -L/usr/local/opt/lapack/lib /usr/local/lib/libmpfi.la /usr/local/lib/libmpfr.la /usr/local/lib/libgmp.la'

# Names of additional weak libraries provided by this library
weak_library_names=''
Expand Down

0 comments on commit b90253a

Please sign in to comment.