Developer’s documentation

Table of contents

• User’s guide
• Developer’s Guide
  • General concepts
  • code_aster package
    • Implementation of commands
    • Objects / DataStructures
    • Description of the user’s keywords
    • Interface with the user syntax
    • Features for the user messages
    • Helpers functions for Commands
    • Common utilities
  • run_aster package
    • bin/run_aster — Script to execute code_aster
    • bin/run_ctest — Script to execute code_aster testcases using ctest
    • run — Main classes for execution
    • create_temporary_dir()
    • RunAster
    • RunOnlyEnv
    • get_procid()
    • get_nbcores()
    • set_num_threads()
    • copy_datafiles()
    • copy_resultfiles()
    • config — Configuration of the version
    • ConfigurationStore
    • Config
    • export — Export file object
    • ExportParameter
    • ExportParameterStr
    • ExportParameterBool
    • ExportParameterInt
    • ExportParameterFloat
    • ExportParameterListStr
    • File
    • Export
    • split_export()
    • settings — Objects to deal with settings
    • subst_vars()
    • AbstractParameter
    • ParameterStr
    • VarMixin
    • ParameterVarStr
    • ParameterBool
    • ParameterInt
    • ParameterFloat
    • ParameterListStr
    • ParameterVarListStr
    • ParameterDictStr
    • Store
    • status — Extract the state of a code_aster execution
    • Status
    • StateOptions
    • get_status()
    • error_messages — Extract error messages from an execution
    • search_msg()
    • _remove_decoration()
    • _regexp_decoration()
    • _add_line_numbers()
    • command_files — Changing commands files
    • add_import_commands()
    • add_coding_line()
    • stop_at_end()
    • file_changed()
    • change_procdir()
    • toolbox — Toolbox for the developers
    • make_shared()
    • utils — Utilities
    • _waitstatus_to_exitcode()
    • logger — Logging and messages output
    • PerLevelFormatter
    • PerLevelColorFormatter
    • HgStreamHandler
    • build_logger()
    • _colorize()
    • red()
    • green()
    • blue()
    • magenta()
    • cyan()
    • yellow()
    • grey()
    • timer — Simple timer
    • Measure
    • Timer
    • ctest2junit — Convert a CTest execution report to JUnit
    • XUnitReport
    • get_state()
    • get_err_msg()
    • get_nook()
  • Python wrapping of DataStructure
    • Files structures
    • Exported methods
    • Pickling support
  • Naming conventions / Python API
    • General rules
    • Glossary
  • Recommendations / howto
    • Definition .h vs Implementation .cxx
    • Default arguments and overloaded methods in Python Interface
    • How to return different types from a unique Python interface
    • Macro-Commands
    • Parallel specific DataStructures
    • Common errors
  • Debugging and profiling
    • Debugging
    • Profiling
  • Writing documentation
    • Introduction
    • Getting started
    • Generating the documentation
    • Resources
  • Low level programming
    • Configuration
  • List of TODOs
• Building and installing code_aster
  • Getting the sources
  • Compiling code_aster
  • Testing your installation
  • Advanced configuration
• Contributing
• EDF development workflow
  • Rules for EDF continuous integration
  • Configure your repository
  • Development workflow
  • List of checkings
• Copyright

Indices and tables

• Index

• Module Index

• Search Page