forked from damaxwell/siple
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
54 lines (31 loc) · 1.47 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
siple: a Small Inverse Problems Library
*************************************************************************
Overview:
The siple library is a collection of python based tools for solving
certain kinds of inverse problems.
Development of this library was supported in part by the National
Science Foundation (grant 0724860) and NASA (grant NNX09AJ38G).
*************************************************************************
Installation:
A basic installation can be done using
python setup.py install
This will install siple at the system-wide level; you might need to run this command with 'sudo' to have the necessary privileges. You
can install it just for your user account using
python setup.py install --user
For other options, use
python setup.py install --help
See also the comments at the start of setup.py
*************************************************************************
Documentation:
The documentation (in progress) is built using sphinx, which must
be installed. See sphinx.pocoo.org.
To build the documentation:
cd docs
make html
The documentation can then be accessed via
docs/build/html/index.html
*************************************************************************
Examples:
The scripts in the examples directory use siple to solve inverse problems
described in the tutorial. See the comments at the beginning of each example to see a brief description of what is being done, and run the example with, e.g.,
python examples/e1/derivative.py