xref: /libCEED/examples/python/README.md (revision 45e62b5fd85c07bf32886201b28fd86143ee0826)
1*45e62b5fSJeremy L Thompson## libCEED Python Examples
2*45e62b5fSJeremy L Thompson
3*45e62b5fSJeremy L ThompsonThese examples are written using libCEED's Python interface.
4*45e62b5fSJeremy L Thompson
5*45e62b5fSJeremy L Thompson### Tutorials
6*45e62b5fSJeremy L Thompson
7*45e62b5fSJeremy L ThompsonThese Jupyter notebooks explore the concepts of the libCEED API, including how to install the Python interface and the usage of each API object, with interactive examples.
8*45e62b5fSJeremy L Thompson
9*45e62b5fSJeremy L Thompson### Basic Examples
10*45e62b5fSJeremy L Thompson
11*45e62b5fSJeremy L ThompsonThe basic libCEED C examples in the folder `/examples/ceed` are also available as Python examples.
12*45e62b5fSJeremy L Thompson
13*45e62b5fSJeremy L ThompsonTo build the QFunctions into a shared library that the Python examples use, run
14*45e62b5fSJeremy L Thompson
15*45e62b5fSJeremy L Thompson```bash
16*45e62b5fSJeremy L Thompsonmake setup
17*45e62b5fSJeremy L Thompson```
18*45e62b5fSJeremy L Thompson
19*45e62b5fSJeremy L ThompsonTo execute the examples, run:
20*45e62b5fSJeremy L Thompson
21*45e62b5fSJeremy L Thompson```
22*45e62b5fSJeremy L Thompsonpython ex1_volume.py
23*45e62b5fSJeremy L Thompson```
24*45e62b5fSJeremy L Thompson
25*45e62b5fSJeremy L ThompsonA full list of command-line arguments are shown by adding the command-line argument "--help".
26