All stages of FiPy development are archived in a Git repository at GitHub. You can browse through the code at https://github.com/usnistgov/fipy and, using a Git client, you can download various tagged revisions of FiPy depending on your needs.
git client application is needed in order to fetch files from our
repository. This is provided on many operating systems (try executing
which git) but needs to be installed on many others. The sources to
build Git, as well as links to various pre-built binaries for
different platforms, can be obtained from http://git-scm.com/.
In general, most users will not want to download the very latest state of FiPy, as these files are subject to active development and may not behave as desired. Most users will not be interested in particular version numbers either, but instead with the degree of code stability. Different branches are used to indicate different stages of FiPy development. For the most part, we follow a successful Git branching model. You will need to decide on your own risk tolerance when deciding which stage of development to track.
A fresh copy of the FiPy source code can be obtained with:
$ git clone https://github.com/usnistgov/fipy.git
An existing Git checkout of FiPy can be shifted to a different <branch> of development by issuing the command:
$ git checkout <branch>
in the base directory of the working copy. The main branches for FiPy are:
- designates the (ready to) release state of FiPy. This code is stable and should pass all of the tests (or should be documented that it does not).
- designates the latest state of code destined for the next release. This
code should be stable and pass all tests, but may be awaiting new
features or bug fixes before merging to
masterand formal release.
Past releases of FiPy are tagged as
- which designates a released version x.y.z. Any released version of FiPy will be designated with a fixed tag: The current version of FiPy is 3.1.3-dev2-g11937196.
Tagged releases can be found with:
$ git tag --list
Any other branches will not generally be of interest to most users.
For some time now, we have done all significant development work on
branches, only merged back to
develop when the tests pass
successfully. Although we cannot guarantee that
develop will never be
broken, you can always check our build status page
to find the most recent revision that it is running acceptably.
Enter search terms or a module, class or function name.