User and developer documentation
Accessing and building dependencies and FACETS
Not needed if you work on a machine that has a team-installed version as shown below.
If you build from scratch, please not the location of your CONTRIB_DIR (where facetspkgs is installed) and FACETS_DIR (where FACETS is installed).
Public FACETS installation directories
| Machine | Programming Env | External packages (facetspkgs) | Development packages (facetsall) |
| Environment variable | CONTRIB_DIR | FACETS_DIR | |
| Default | /contrib | /internal | |
| carver.nersc.gov | pgi | /project/projectdirs/facets/carver/contrib-pgi-10.5 | /project/projectdirs/facets/carver/internal-pgi-10.5 |
| franklin.nersc.gov | pathscale | /project/projectdirs/facets/franklin/contrib-path-3.2 | /project/projectdirs/facets/franklin/internal-path-3.2 |
| hopper.nersc.gov | pgi | /project/projectdirs/facets/hopper/contrib-pgi-10.3 | /project/projectdirs/facets/hopper/internal-pgi-10.3 |
| intrepid.alcf.gov | xl | /home/projects/facets/intrepid/contrib | /home/projects/facets/intrepid/internal |
| jaguar.ccs.ornl.gov | /tmp/work/cary/jaguar/contrib | /tmp/work/cary/jaguar/internal | |
| benten.gat.com | /d/facets/contrib | /d/facets/internal |
The above environment variables are used elsewhere in the build instructions.
Configuring your environment
The installations will include files suitable for source (this should be done after module load commands for systems that use the module system).
For bash users:
source $CONTRIB_DIR/facetspkgs.sh source $FACETS_DIR/facetsall.sh
For cshrc/tcshrc users:
source $CONTRIB_DIR/facetspkgs.csh source $FACETS_DIR/facetsall.csh
If you are only interested in testing the code, you may skip down to the usage instructions.
Regression and unit tests
This also includes build and code integrity checks.
Performance tests
Weekly performance test results for FACETS::Core solver on Franklin
Performance test results for NUBEAM
Performance test results for UEDGE
Performance results of different topologies for FACETS/Gyro
Usage overview
Example of using FACETS using the training repository
Core-Edge workflow overview and running Core-Edge simulations
Metadata summary: Summary of the metadata stored with each run.
Using Visit for visualization
Please refer to https://ice.txcorp.com/trac/vizschema/wiki/WikiStart.
FACETS Composer
Framework documentation
C++ interfaces to transport models
Creating components from legacy code: principles
How to bring an external component into FACETS
Notes on Writing Internal Updaters
Component specific documentation
Allocations at Leadership Class Facilities for FACETS
FACETS mailing list archive search
Other information
Collaboration repositories
To keep the repos reasonable in size, we have repos for each project year, obtained by
- svn co https://ice.txcorp.com/svnrepos/collabs/facetscollab2007
- svn co https://ice.txcorp.com/svnrepos/collabs/facetscollab2008
- svn co https://ice.txcorp.com/svnrepos/collabs/facetscollab2009
- svn co https://ice.txcorp.com/svnrepos/collabs/facetscollab2010
- svn co https://ice.txcorp.com/svnrepos/collabs/facetscollab2011
that contain
- Collaboration meetings
- Reports
- Papers
- Presentations
- Priorities
- Proposals
- Reports
- Reviews
In addition, we have the project duration repo, obtained by
- svn co https://ice.txcorp.com/svnrepos/code/facetsweb
that contains materials that go up on the web and materials that are roughly constant over the life of the project. In particular, the contents include
- Collaboration meetings (brought in with svn:externals from the yearly repos)
- Documentation
- Images
- Logos
- Member lists
- Original proposal
this repo is visible on the web at https://www.facetsproject.org/facetsweb.
In all cases, the repo is downloaded through svn via
svn co <URL>
Related web sites
FMCFM site FMCFM is the bindings to all of the transport flux calculations. It provides uniform interfaces to such models as GLF23, NCLASS, and GYRO.
GYRO site GYRO is a gyrokinetic turbulence code for modeling the turbulence in a tokamak. As part of an embedded Science Application Partnership, it is embedded within the transport calculation to provide accurate modeling of the fluxes.
NTCC site Although now defunct, the National Transport Code Code Collaboration served as the basis for many of the components within FACETS.
