1 | # This program is public domain |
---|
2 | """ |
---|
3 | PARK fitting service. |
---|
4 | |
---|
5 | The PARK fitting service is a set of python packages to support |
---|
6 | fitting in datasets. Using common python infrastructure such |
---|
7 | as scipy optimizers, numpy arrays, and matplotlib plotting, park |
---|
8 | allows you to define models, associate them with datasets and |
---|
9 | simultaneously fit them. Park provides a simple job queue to |
---|
10 | manage multiple fits using separate processes or running across |
---|
11 | the network on separate machines. |
---|
12 | |
---|
13 | Installation |
---|
14 | ============ |
---|
15 | |
---|
16 | The latest version of Park is available from |
---|
17 | http://www.reflectometry.org/danse/park. |
---|
18 | |
---|
19 | |
---|
20 | Currently this is supplied as source from a zip file. You can |
---|
21 | also retrieve the latest version from svn:: |
---|
22 | |
---|
23 | svn co svn://danse.us/park/branches/park-1.2 |
---|
24 | |
---|
25 | If you are installing from source, you will need a python |
---|
26 | environment with numpy and scipy. For the GUI version, you |
---|
27 | will also need matplotlib and wx. |
---|
28 | |
---|
29 | You will need a C compiler to build the resolution convolution |
---|
30 | function. On Windows this may require installing MinGW and |
---|
31 | adding distutils.cfg to your distutils directory:: |
---|
32 | |
---|
33 | [build] |
---|
34 | compiler = mingw |
---|
35 | |
---|
36 | Once you have the required supporting packages, use the following |
---|
37 | to build and install:: |
---|
38 | |
---|
39 | python setup.py install |
---|
40 | |
---|
41 | Usage |
---|
42 | ===== |
---|
43 | |
---|
44 | To get started with park, you will need to first define the |
---|
45 | models that you are using. These can be very basic models, |
---|
46 | listing all possible fitting parameters. When setting up the |
---|
47 | fit later, you will be able to combine models, using |
---|
48 | parameter expressions to relate the values in one model with |
---|
49 | those in another. See `park.model` for details. |
---|
50 | |
---|
51 | Once your models are constructed you can use them in a fit. |
---|
52 | See `park.fit` for details. |
---|
53 | |
---|
54 | Important classes and functions: |
---|
55 | `park.model.Model`, `park.parameter.ParameterSet`, `park.fit.Fit` |
---|
56 | |
---|
57 | :group models: model, assembly, parameter, data |
---|
58 | :group examples: peaks |
---|
59 | :group optimizer: fit, fitresult, fitmc, simplex |
---|
60 | :group support: expression, deps, version, setup, serial |
---|
61 | :group server: fitservice |
---|
62 | """ |
---|
63 | |
---|
64 | #from fitservice import * |
---|
65 | from parameter import * |
---|
66 | from data import * |
---|
67 | from model import * |
---|
68 | from assembly import * |
---|
69 | import fit |
---|
70 | |
---|