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

Update README.md #181

Open
edan-bainglass opened this issue Jul 17, 2024 · 2 comments
Open

Update README.md #181

edan-bainglass opened this issue Jul 17, 2024 · 2 comments

Comments

@edan-bainglass
Copy link
Member

The README.md examples do not reflect the current state of the docs and suggest a different use of the work graph.

@superstar54
Copy link
Member

superstar54 commented Aug 5, 2024

@edan-bainglass suggests using task.calcfunction instead of asking users to import calcfunction from the aida.engine.

So update the README to

# define add calcfunction
@task.calcfunction
def add(x, y):
    return x + y

@edan-bainglass
Copy link
Member Author

Indeed. The fact that AiiDA's mechanics are supported is a neat feature. But at the end of the day, the real gain from aiida-workgraph is that one doesn't need to know about AiiDA (e.g. no AiiDA imports necessary).

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

No branches or pull requests

2 participants