File: calceph.misc.pythonusage.rst

package info (click to toggle)
calceph 4.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 15,944 kB
  • sloc: ansic: 21,414; fortran: 4,054; python: 1,569; sh: 197; makefile: 5
file content (49 lines) | stat: -rw-r--r-- 1,072 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

.. include:: replace.rst

Miscellaneous functions
=======================

|menu_calceph_getmaxsupportedorder|
-----------------------------------

.. py:method:: calcephpy.getmaxsupportedorder (segid)  

    :param  int segid: |arg_segid|
    :return: |arg_version|
    :rtype: str 


This function returns the maximal order of the derivatives computed by the functions |calceph_compute_order|, |calceph_orient_order|, ....  for the segment type *segid*.
If the segment type is unknown by the library, the function returns -1.


The accepted values of *segid** are the predefined constants *Constants.SEGTYPE_...* (:ref:`Constants`).


::

    from calcephpy import *
    maxorder = getmaxsupportedorder(Constants.SEGTYPE_SPK_2)
    print('maximal order is ', maxorder)



|menu_calceph_getversion_str|
-----------------------------

.. py:method:: calcephpy.getversion_str () 

    :return: |arg_version|
    :rtype: str 



This function returns the version of the |LIBRARYNAME|, as a string.

::

    from calcephpy import *
    print('version=', getversion_str())