PYGILDAS: Interleaving Python and GILDAS End-user and developer documentation
Keywords: gildas-python

Next: Context Contents Index

# PYGILDAS: Interleaving Python and GILDAS
End-user and developer documentation

Sébastien Bardeau, Emmanuel Reynier,

Jérôme Pety and Stéphane Guilloteau

24-apr-2018

Version 0.8

Note: this is the on-line version of the Introduction to the Python port of GILDAS. A PDF version is also available.

Related information is available in:

- GREG: Grenoble Graphics
- SIC: Simple Interpretor of Commands

- Context
- End-user documentation
  - Prerequisites (what you have to know)
    - Python basics
      - Identifiers
      - Multidimensional-array arrangement in memory
      - The `vars()` built-in function
      - The `dir()` built-in function
      - The `__doc__` attribute
      - Global/local variables and module name spaces
    - `NumPy` basics
      - Attributes
      - Methods
      - Functions
      - Subarrays and derivates
  - Using Python from SIC
    - The SIC command `PYTHON`
    - Calling Python functions
  - Using SIC from Python
    - PyGildas modules
    - Special commands
    - The `gdict` container
    - The `Sic` object in Python `__main__`
  - Importing SIC objects
    - SIC arrays
    - SIC scalars
    - SIC structures
    - SIC images
    - Handling character strings
  - Object status in SIC:
    - Read-only or read-and-write?
    - Global or local variable (in the SIC sense)?
- Programmer documentation
  - Installing PyGILDAS
    - Prerequisites
    - How to build your own Python version
    - Python module `readline` for command history
    - Install `NumPy` module for Python
    - Install `scipy` module for Python (optional)
    - Compiling Gildas with your custom Python (if any)
  - How SIC variables are imported
    - Comments on the strategy
    - The `SicVar` class
    - The `SicStructure` class
  - Array elements types
- Python 3K
  - References
  - Standard end-user
  - Developers using the Python binding
  - Developers of Fortran GILDAS packages
- What's new?
- Contents
- Index
- About this document ...