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.

Sign up for GitHub

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

📝 doc: new references to external resources #190

Merged
merged 3 commits into from
Oct 8, 2024
Merged

📝 doc: new references to external resources #190

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7a0a76
enh doc
pcrespov Oct 8, 2024
8161166
update structure
pcrespov Oct 8, 2024
0897fd3
imprves tip
pcrespov Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions docs/doc_entrypoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![PyPI - Release](https://img.shields.io/pypi/status/osparc)](https://pypi.org/project/osparc/#history)
[![PyPI Downloads](https://img.shields.io/pypi/dm/osparc)](https://pypi.org/project/osparc/)


`osparc` is a Python package that provides tools and functionalities to interact with the o²S²PARC platform. It allows for seamless integration and automation of workflows in simulation science, making it easier to handle simulations and access [o²S²PARC services](https://github.com/ITISFoundation/osparc-simcore)

## Features
Expand All @@ -21,10 +20,8 @@ You can install `osparc` directly from PyPI:
pip install osparc
```


## Getting Started with `osparc`


### API Key/Secret Setup

Before interacting with the osparc API, you need to generate an API key-secret pair from your osparc account. Follow the [instructions here](https://docs.osparc.io/#/docs/platform_introduction/user_setup/security_details?id=generating-o%c2%b2s%c2%b2parc-tokens) to create the key and secret.
Expand Down Expand Up @@ -72,16 +69,17 @@ with ApiClient() as api_client:

### Additional Resources

For more in-depth usage, refer to the following tutorial guides:
For more in-depth usage, refer to the following resources:

- [Version 0.5 Documentation](clients/python/docs/v0.5.0/README.md)
- [Version 0.6 Documentation](clients/python/docs/v0.6.0/README.md)
- 📚 Documentation
- [Version 0.6](clients/python/docs/v0.6.0/README.md)
- [Version 0.5](clients/python/docs/v0.5.0/README.md)
- [Community-Contributed Scripts](https://github.com/topics/osparc-python)
- ✨ [gh:newton1985/osparc_api_example](https://github.com/newton1985/osparc_api_example): A repository containing a "standalone" sample project that illustrates the use of the osparc API

>💡 If you want your scripts to be listed here, just create a github repository and [tag it with the `osparc-python` topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics).


## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

---

Make sure to replace `your-username` with your actual GitHub username or repository link, and feel free to modify the sections as necessary.
Loading