Arcane

CEA logo and IFPEN logo

This page contains the documentation for users of the Arcane platform.

The New features and Changes page presents a list of new features for each version.

The documentation accessible from this page is intended for people who wish to learn about the functionalities of the Arcane platform or who wish to develop modules or services capable of running on the Arcane platform.

All people developing modules or services for Arcane must at least know the documents Getting Started with Arcane and Fundamental Types. Furthermore, to get the details of a class's operations, for example to know all the methods of the Arcane::Cell class, you must consult the online documentation of the Arcane source codes.

The documentation consists of chapters (listed below), which themselves consist of sub-chapters and/or pages.

Each chapter/sub-chapter has a summary briefly describing its content and a list of its pages.

To configure the documentation, click here: Documentation Customization

The available chapters are:

• Compilation and installation
  Presents how to compile and install the Arcane framework.
• Getting Started with Arcane
  Briefly presents the principles and basic types of Arcane.
• Fundamental Types
  Presents the key concepts of Arcane (modules, variables, entry points, services, and different file types).
• Execution, runtime
  Presents the elements you need to know to make Arcane code run (starting a calculation, environment variables).
• Generalities
  Presents elements that should be known, such as coding rules.
• Examples and tutorial
  Presents Arcane examples.
• Parallelizing code
  Presents the different ways to parallelize Arcane code.
• Accelerator API
  Presents the mechanisms available in Arcane to use accelerators (GPU) in Arcane.
• Materials and Environment
  Presents the material part of Arcane.
• Inputs / Outputs (IO)
  Presents the different ways to input and output data.
• Debugging, Performance, and Validation
  Presents various methods to help with debugging, performance analysis, unit testing, and code validation.
• Using Other Languages
  Presents the other languages with which Arcane can be coupled (currently, only C#).
• Entities, meshes, and connectivities
  Presents the entities available in Arcane (predefined cell types, meshing, entity connectivities, and description of classes managing geometry).
• Available Services and Modules
  Presents the services and modules made available to users