Skip to content
Snippets Groups Projects
Commit 6b4951bb authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

mv py/start up

parent 4fe19b7a
No related branches found
No related tags found
1 merge request!1746webdoc: reorganize fit directories
...@@ -24,7 +24,36 @@ one can ...@@ -24,7 +24,36 @@ one can
* extend the functionality of the BornAgain core, for instance * extend the functionality of the BornAgain core, for instance
by adding particle form factors or correlation functions. by adding particle form factors or correlation functions.
#### Tutorial ##### Install
Read on: Install Python and the BornAgain Python module as explained in the
{{% children %}} [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" %}}).
File moved
+++
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" %}}).
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment