Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add user documentation #77

Open
svenkarol opened this issue Jan 27, 2021 · 2 comments
Open

Add user documentation #77

svenkarol opened this issue Jan 27, 2021 · 2 comments

Comments

@svenkarol
Copy link
Collaborator

Somebody should add some documentation on how to get some of the examples running. I think of a short intro on how to generate code and how to compile and run a simulation. Also syntax should be explained somewhere.

@lschuetze
Copy link
Collaborator

Currently, the only way is to

  1. install a local copy of OpenPME and prepare your MPS installation such that you can build the project and the examples (see README.md)
  2. Given you opened an example, you can open the context and select "Preview Generated Text"
  3. Copy the content of the opened file containing the generated code
  4. Paste it into a file
  5. Prepare a Makefile by looking into the OpenFPM examples
  6. Install OpenFPM and execute the project

@lschuetze lschuetze changed the title Add some documentation Add user documentation Feb 5, 2021
@kraatz
Copy link
Collaborator

kraatz commented Feb 10, 2021

Step 2-4 can be combined if you select "Rebuild model" in the context menu of the model containing the example. This generates an output file in the solutions folder of the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants