crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-25 12:35:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add links to Python resources in main Python API doc page

Browse source
This commit is contained in:
Paul Romano 2015-08-10 13:11:05 +07:00
parent 812858cca0
commit 8fff5b1810
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/source/pythonapi/index.rst
View file

@ -6,8 +6,12 @@ Python API
OpenMC includes a rich Python API that enables programmatic pre- and
post-processing. The easiest way to begin using the API is to take a look at the
example Jupyter notebooks provided. The full API documentation serves to provide
more information on a given module or class.
example Jupyter_ notebooks provided. However, this assumes that you are already
familiar with Python and common third-party packages such as NumPy_. If you have
never programmed in Python before, there are many good tutorials available
online. We recommend going through the modules from Codecademy_ and/or the
`Scipy lectures`_. The full API documentation serves to provide more information
on a given module or class.
**Handling nuclear data:**
@ -60,3 +64,8 @@ more information on a given module or class.
examples/pandas-dataframes
examples/tally-arithmetic
.. _Jupyter: https://jupyter.org/
.. _NumPy: http://www.numpy.org/
.. _Codecademy: https://www.codecademy.com/tracks/python
.. _Scipy lectures: https://scipy-lectures.github.io/