| 1 | Release Notes |
|---|
| 2 | ============= |
|---|
| 3 | |
|---|
| 4 | SANS Models version 0.4.1 |
|---|
| 5 | |
|---|
| 6 | Package name: sans.models |
|---|
| 7 | |
|---|
| 8 | 1- What's New in Version 0.? |
|---|
| 9 | - Release date: ? |
|---|
| 10 | - C extension models now use new C++ classes that incorporate dispersity and averaging |
|---|
| 11 | functionality. See utest_dispersity.py for examples of how to use the new dispersion |
|---|
| 12 | classes. |
|---|
| 13 | |
|---|
| 14 | # Create a model |
|---|
| 15 | model= CylinderModel() |
|---|
| 16 | |
|---|
| 17 | # Create a dispersion model |
|---|
| 18 | disp = GaussianDispersion() |
|---|
| 19 | |
|---|
| 20 | # Set the dispersion for a chosen parameter |
|---|
| 21 | model.set_dispersion('radius', disp) |
|---|
| 22 | |
|---|
| 23 | # Set the parameters of the dispersion model |
|---|
| 24 | model.dispersion['radius']['width'] = 5.0 |
|---|
| 25 | model.dispersion['radius']['npts'] = 100 |
|---|
| 26 | |
|---|
| 27 | |
|---|
| 28 | Version 0.4.1 |
|---|
| 29 | - Release date: 6/9/2008 |
|---|
| 30 | - Modified non-shape models so that the 2D output is the 1D output for the length of Q |
|---|
| 31 | |
|---|
| 32 | Version 0.4.0 |
|---|
| 33 | - Release date: 4/15/2008 |
|---|
| 34 | - Added shape-independent models. |
|---|
| 35 | |
|---|
| 36 | Version 0.3.2: |
|---|
| 37 | - Release date: 2/14/2008 |
|---|
| 38 | - Added models to be used in magnetic analysis. |
|---|
| 39 | |
|---|
| 40 | |
|---|
| 41 | 2- Downloading and Installing |
|---|
| 42 | |
|---|
| 43 | 2.1- System Requirements: |
|---|
| 44 | - Python version >= 2.4 should be running on the system |
|---|
| 45 | |
|---|
| 46 | 2.2- Installing: |
|---|
| 47 | - Get the code from svn://danse.us/sans/releases/sansmodels-0.4.0 |
|---|
| 48 | - Execute the following: |
|---|
| 49 | python setup.py install |
|---|
| 50 | |
|---|
| 51 | 3- Known Issues |
|---|
| 52 | |
|---|
| 53 | 3.1- All systems: |
|---|
| 54 | - Q range validity of I(q) calculations. |
|---|
| 55 | Our 1D models of I(q) use the function of the NCNR library |
|---|
| 56 | for their IGOR package (Klein, 2006). That library uses a |
|---|
| 57 | fsat integration technique in some of its models (cylinders |
|---|
| 58 | and ellipsoids). Integration is done using 76 points in the |
|---|
| 59 | angle between the axis of the object and the q-vector, which |
|---|
| 60 | translates in a larger inaccuracy at high q. Integratiing |
|---|
| 61 | the 2D model I(q,phi) over all orientations of the object |
|---|
| 62 | will not yield the exact same result as the NCNR calculation |
|---|
| 63 | for q > 0.3 A-1. |
|---|
| 64 | - Refactoring needs to be done to update the model base class. |
|---|
| 65 | We should get rid of the useless arithmetics and store the parameters |
|---|
| 66 | as class objects rather than values. This would eliminate the multitude |
|---|
| 67 | of dictionaries needed to store all the various aspects of a parameter |
|---|
| 68 | (limits, units, dispersity information). The C++ design it relies |
|---|
| 69 | on is much cleaner in that respect, but it still depends on the old |
|---|
| 70 | C computation. Those should be incorporated in the C++ classes. |
|---|
| 71 | |
|---|
| 72 | 3.2- Windows: |
|---|
| 73 | - None |
|---|
| 74 | |
|---|
| 75 | 3.3- Linux: |
|---|
| 76 | - None |
|---|
| 77 | |
|---|
| 78 | 4- Troubleshooting |
|---|
| 79 | |
|---|
| 80 | - None |
|---|
| 81 | |
|---|
| 82 | 5- Frequently Asked Questions |
|---|
| 83 | |
|---|
| 84 | - None |
|---|
| 85 | |
|---|
| 86 | 6- Other Resources |
|---|
| 87 | |
|---|
| 88 | - See: http://danse.us/trac/sans/wiki/8_2_2_1DModelFitting |
|---|
| 89 | - See: http://danse.us/trac/sans/wiki/8_2_3_2DModeling |
|---|
| 90 | - See: http://danse.us/trac/sans/wiki/8_2_6_model_extensions |
|---|
| 91 | - See: http://danse.us/trac/sans/wiki/8_2_1Nonshape_models |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
