Skip to content
Snippets Groups Projects
Commit 11ad6961 authored by Tamas Simon's avatar Tamas Simon
Browse files

Updated documentation

parent 38f19573
No related branches found
No related tags found
No related merge requests found
......@@ -16,15 +16,30 @@ The package can be currently installed from the GitLab repository:
pip install git+https://git.dynare.org/Dynare/dynare-python.git
```
## Example
For an example on how to use the package, see `test/test_dynare.py`.
### Simple example
### Quickstart
```python
from dynare import dynare
context = dynare("<path_to_model_file.mod>")
print(context)
```
\ No newline at end of file
```
## Example
For an example on how to use the package, see `test/test_dynare.py`.
## Configuration
To reuse and existing Julia environment, set the `PYTHON_JULIAPKG_EXE=<exe>` and `PYTHON_JULIAPKG_PROJECT=<project>` environment variables as documented in [pyjuliapkg](https://github.com/JuliaPy/PyJuliaPkg?tab=readme-ov-file#configuration).
### No X-Windows server
Dynare will try to open windows on your machine when it's completed computing. If there is no display on your system, you probably want to set the following environment variables to avoid related
error messages:
```
export QT_QPA_PLATFORM=offscreen
export DESKTOP_SESSION=none
```
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