Ferret is an application within the MOOSE framework. To build and use Ferret you will need to build MOOSE. It might be a good idea to learn a few things about MOOSE, too.
Generally, you will clone Ferret this way:
git clone https://firstname.lastname@example.org/mesoscience/ferret.git
If you have write permissions, cloning this way will enable you to push to the repo.
Generally this means that you are a member of the
mesoscience BitBucket team.
If you only have read permissions, you might want to clone this way:
git clone bitbucket.org/mesoscience/ferret.git
Once MOOSE is built, Ferret can usually be built simply as
cd <ferret> ./configure make METHOD=opt MOOSE_DIR=<moose>
make METHOD=opt MOOSE_DIR=<moose> -j 4
to make the compile go faster.
<ferret> is the location of the Ferret clone, and
<moose> is the MOOSE clone.
Naturally, use an appropriate
METHOD -- one of those that was used to build MOOSE
If libMesh is built in a non-standard location (i.e., NOT built inside the MOOSE tree
LIBMESH_DIR also has
to be set:
make METHOD=opt MOOSE_DIR=<moose> LIBMESH_DIR=<libmesh>
NOTE: The ./configure step can alternatively include a BOOST directory which will allow compile of MOOSE objects with mathematical special functions.
Who do I talk to?
The following people are contributors to the Ferret project and can be reached by email for help:
John Mangeri (email@example.com)
- Serge Nakhmanson (firstname.lastname@example.org)
- Olle Heinonen (email@example.com)
- Lukasz Kuna (firstname.lastname@example.org)
MOOSE can be found at http://www.mooseframework.org
- The moose-users list at https://groups.google.com/forum/#!forum/moose-users is a great link for help with MOOSE or new implementations.
- If you have an idea for some ferroelectric materials problem and would like to add it to the repository, then please submit a pull request to the devel branch with the relevant information. Generally, to submit a pull request, you should fork Ferret, type git checkout devel, git fetch origin, git rebase origin/devel, then make the changes/additions and a commit message, type git push. Then submit the pull request on the page (the next steps will be handled automatically).
- At the moment, please cite Nanoscale, 2017, 9, 1616-1624 if you use Ferret. A methods paper is currently in the works.