PySIT Extension Development Guide¶
Note
Any methods or algorithms from the literature that are not patent or license restricted can be included directly within the PySIT Core package. If any part of your extension fits these criteria (must be BSD licensed) and you think that it will be useful to the rest of the community, we strongly encourage you to do so. For example, if you add support for a new acquisition geometry or a new gallery problem, submit these as a pull request to the core package, rather than releasing them through your extension.
To move existing research code into a PySIT extension:
- Clone or fork the example PySIT Extension package from BitBucket.
- Rename the
example
to the name of your extension. - Update the configuration in
setup.py
. - Update the
licenses/license.rst
file. - Copy your new script files to the
pysit_extensions-<extname>/pysit_extensions
directory. It is requested that you follow the PySIT package structure wherever possible: e.g., new solvers go in thesolvers
directory and new objective functions go in theobjective_functions
directory. - Copy any demo or example scripts into the
examples
directory. - Setup the configuration to build any C, C++, fortran, or Cython extensions.
- If releasing publically, configure and upload to PyPI.