Skip to content

Conversation

@FilipeFcp
Copy link
Contributor

Hi all. This is the first version of the Web API FAQ.

Let me know any corrections and suggestions

Copy link
Contributor

@alec-flexcompute alec-flexcompute left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job as always @FilipeFcp ! I myself learned new things about our API here haha.

One thing I'd add is, for the abort file, you might want to mention that simply cutting off the running of the python file doesn't abort the simulation once it's submitted to our cloud.

Nice job again, it looks well-made for LLMs to learn from it too!

Copy link
Collaborator

@e-g-melo e-g-melo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @FilipeFcp! Thanks for creating these FAQs!

  • As a general comment, I think we often use "task" and "simulation" interchangeably in our documentation. However, I believe some people can't immediately realize what "task" means. So, I recommend consistently using "simulation" whenever possible to prevent confusion.

  • In _faqs/web.load.md it would be interesting to comment on how to retrieve the task_id from a simulation or design_optimization in GUI. Maybe refer the user to that tutorial about downloading and plotting datasets from GUI.

  • When you have time, it would be nice to add get_info, delete, delete_old, and run_async.

Copy link
Contributor

@tomflexcompute tomflexcompute left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @FilipeFcp !

@FilipeFcp
Copy link
Contributor Author

Thanks all.
@e-g-melo, I will create a different PR for the other classes

@FilipeFcp FilipeFcp merged commit 208589c into develop Sep 18, 2025
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

Successfully merging this pull request may close these issues.

5 participants