Clone this wiki locally
SciD is a collection of numerical routines and bindings written in and for the D programming language. Currently, the collection is rather small (see below) but expanding.
For the time being, SciD simply aims to be a freely usable repository of numerical algorithms. The long-term goal is to ultimately produce a full-fledged, general-purpose scientific library à la the GNU Scientific Library or SciPy.
Cristi Cobzarenco's "Google Summer of Code" project has evolved into a matrix/vector library which will perhaps become a part of SciD! You can follow his progress at his SciD fork here on GitHub.
Below is a list of the main modules. Click on the links to get to the documentation (updated 2011-06-25).
- scid.calculus: Numerical integration (quadrature) and differentiation.
- scid.constants: Fundamental constants of mathematics and Nature.
- scid.functions: Mathematical special functions.
- scid.linalg: Linear algebra functions, i.e. user-friendly interfaces to LAPACK.
- scid.matrix: Contains the MatrixView type, which is a LAPACK-compatible matrix view of ordinary D arrays, as well as some utility functions.
- scid.nonlinear: Methods for nonlinear equation solving.
- scid.types: Various useful types.
- scid.util: Various odds and ends that don't fit anywhere else.
There are also a few subpackages (click one of the links above and you'll find the API docs for these in the package tree):
- scid.core: Things that are not directly related to numerics, mainly for internal use.
- scid.bindings: Bindings to third-party libraries. Currently only contains the BLAS and LAPACK bindings by Bill Baxter. (Thanks, Bill!)
- scid.ports: This is where a lot of the action actually takes place. This package contains ports of FORTRAN and C code from various sources, mainly Netlib. It's been ported it using a "get it to work - NOW" philosophy, and as such a lot of it is just FORTRAN code written with D syntax. Consider yourself warned.
SciD is very much a work in progress, and as such, the API is subject to breaking changes without notice. Furthermore, for the time being, no attempt will be made to retain compatibility with older versions of DMD and Phobos.
- DMD >=2.053
- BLAS and LAPACK libraries
BLAS and LAPACK should be available in the package repositories of most Linux distros. Windows users may want to download the prebuilt binaries that are available on the MultiArray project page on DSource (look for multiarray-deps.zip under "Vitals").
Currently, the only way to get SciD is to download the development version from the repository. To download the code, use the following command:
git clone git://github.com/kyllingstad/scid.git
This will create a new directory named 'scid' containing a duplicate of the SciD repository. When you have already cloned the repository and want to update it with the latest changes, run:
To build SciD, use the D program
build.d, found in the root directory of the repository. The best way to run it is using the rdmd program which is bundled with the DMD compiler. To build the library and generate header files, run:
To generate the documentation, run:
rdmd build html
The generated files can be found in the
generated/ subdirectory. Currently, further installation must be done manually, but this will improve soon.
For numerical code, performance is key. However, there are enough libraries that provide awesome performance behind a butt-ugly API, so SciD need not go down that road. The design priorities are therefore, in order,
- Correctness: Make the code work, and make it produce correct results.
- User-friendliness: Give the code a nice API.
- Performance: Optimise the code.
Luckily, D is the perfect programming language for hiding high-performance code behind a beautiful API, so ultimately SciD should be able to provide as good performance as other libraries.
As stated in the introduction, a goal of SciD is to become a community project. Contributors are very welcome, so if you want to participate, let me know.
Here's a small tip: There is a lot of established and extremely well tested numerical code lying around the Internet, just waiting to be ported to D. A lot of it is in the public domain, so we are free to use it in any way we want. Instead of spending a lot of time re-inventing the wheel, port some existing code and try to improve on it when you get it working.
Here are a few starting points:
- NetLib - the ultimate source of numerics software. It contains hundreds (thousands?) of algorithms, mainly written in FORTRAN, but you'll also find some C code there. The code is organised by (not-always-so-intuitive) package names only, therefore it is nice to have...
- GAMS - the Guide to Available Mathematical Software, which indexes and categorises the code in Netlib and a bunch of other sources.