DOCS: Add examples section

[SMoraisAnsys]

Following OSS guidance, we should add an "Examples" section to the documentation.
This working I worked on it and I'll propose changes allowing us to have examples in the documentation.

The current approach I'm following is to use a python file such that:

• examples are at root level of the repo (easier to find for users)
• examples can be executed as python scripts (with some extra labels to help following bullet point)
• examples can be run as notebooks with jupyterlab (you would see texte cells and code cells)
  However, this approach comes with the following price : we can't provide pre run notebooks (I mean with code cells results)

Another approach would be to execute the example on my laptop and to provide the final result as a notebook (with pre filled code cells results which would be my own execution). This approach does not provide the previous listed benefits of the other approach and comes at the price of having to re run manually the examples if they happen to be updated or their code cells results differs.

If there was a way to have a VM + github runner which could use the project to run the examples that would be great. I can take care of the VM creation + github runner setting but I don't know how to make it work with concepev.

@philipjusher Let me know which approach suits you best (I'll propose a PR with the first one) and if there is a way to use a VM or not.

[philipjusher]

I think we can use /examples/simple_workflow.py as the examples. Do you mean the example script should be up one directory then? We will need to add some auth things to the github repo to get environment variables set for authenticating with the server. Then this script should be "runnable" in a github runner. Is that what we need?

[SMoraisAnsys]

I think we can use /examples/simple_workflow.py as the examples. Do you mean the example script should be up one directory then? We will need to add some auth things to the github repo to get environment variables set for authenticating with the server. Then this script should be "runnable" in a github runner. Is that what we need?

I was suggesting to having a directory with examples and simple_workflows.py would be one of them. However, that's just the beginning and you might want to extend it.
As for running the example in Github, we could use one of our self-hosted runner but we need to discuss about how we must configure the env. variables / secrets values to make it work.

[philipjusher]

So we can use the github secrets to set up the env and it will use those envs in a github action. We wont need a self hosted runner can just use a github hosted runner.

[SMoraisAnsys]

So we can use the github secrets to set up the env and it will use those envs in a github action. We wont need a self hosted runner can just use a github hosted runner.

Awesome, I though we would require to install specific stuff.
Can you handle the creation of the secret values ?

[philipjusher]

yeah there are secret values. They should read from dotenv.