diff --git a/hugo/content/py/_index.md b/hugo/content/py/_index.md index cd9ea324e6df3fdf9fcd150098928ba4f62c7014..c391c8ec99f5b336a41207c0ce69c359a1131aca 100644 --- a/hugo/content/py/_index.md +++ b/hugo/content/py/_index.md @@ -24,7 +24,36 @@ one can * extend the functionality of the BornAgain core, for instance by adding particle form factors or correlation functions. -#### Tutorial +##### Install -Read on: -{{% children %}} +Install Python and the BornAgain Python module as explained in the +[installation instructions]({{% relref "installation" %}}). + +##### Check installation + +Launch a Python shell, notebook or IDE. +At the Python command prompt, enter the command +``` +import bornagain +``` +If the BornAgain module is found, Python will just print the next command prompt. +Otherwise it will raise a `ModuleNotFoundError`. + +##### Run first example script + +[Run a first example script](run). +Then read the [explanation](syntax). + +##### Modify some example + +Finally, to start productive work, +choose an example script that somehow ressembles your application problem, +and modify it step by step. + +Examples can be found +- in these web docs in section [Script examples](/ex); +- in the BornAgain sources in directory {{% ref-src "auto/Examples" %}}. + +Most examples are covered by nightly tests. +If nonetheless an example does not work as expected, +then please [report this as a bug]({{% relref "howto/get-help" %}}). diff --git a/hugo/content/py/start/run.md b/hugo/content/py/run.md similarity index 100% rename from hugo/content/py/start/run.md rename to hugo/content/py/run.md diff --git a/hugo/content/py/start/_index.md b/hugo/content/py/start/_index.md deleted file mode 100644 index dbc4557f83205a29dcdea0dad22c9bb92e773016..0000000000000000000000000000000000000000 --- a/hugo/content/py/start/_index.md +++ /dev/null @@ -1,40 +0,0 @@ -+++ -title = "Getting started" -weight = 1 -+++ - -## Getting started with Python scripting - -##### Install - -Install Python and the BornAgain Python module as explained in the -[installation instructions]({{% relref "installation" %}}). - -##### Check installation - -Launch a Python shell, notebook or IDE. -At the Python command prompt, enter the command -``` -import bornagain -``` -If the BornAgain module is found, Python will just print the next command prompt. -Otherwise it will raise a `ModuleNotFoundError`. - -##### Run first example script - -[Run a first example script](run). -Then read the [explanation](syntax). - -##### Modify some example - -Finally, to start productive work, -choose an example script that somehow ressembles your application problem, -and modify it step by step. - -Examples can be found -- in these web docs in section [Script examples](/ex); -- in the BornAgain sources in directory {{% ref-src "auto/Examples" %}}. - -Most examples are covered by nightly tests. -If nonetheless an example does not work as expected, -then please [report this as a bug]({{% relref "howto/get-help" %}}). diff --git a/hugo/content/py/start/syntax.md b/hugo/content/py/syntax.md similarity index 100% rename from hugo/content/py/start/syntax.md rename to hugo/content/py/syntax.md