Shimoku Cloud
Persist your data with us
Last updated
Persist your data with us
Last updated
Review your inbox and confirm account
Click on "Return to Sign In section" and sign in with your credentials
Click your Profile button on the top right and go to "Settings". Inside "Information for developers" click on "Create" to generate your API Token and save this information, the "Universe ID" and the "Business ID" also known as Workspace ID.
Once you execute this piece of code you can see the following plot in your shimoku.io page:
As it can be seen in the previous image the first element in the menu is called 'Custom Board', this element is a board. The boards are necessary for the contents of a menu path to be seen, if a menu path is not included in a board it will not appear in the page. For this reason the SDK always attaches the menu paths to a board when creating content, ideally the user should define which name to use for the board, but when it is not specified it will use the name 'Default Name'.
The method to specify the board's name that the SDK should use is:
This will ensure that all the menu paths used after that point are included in name
.
For more detailed information see Menu
There is now the option to monitor the SDK flow of execution, with three levels of verbosity. This will help to know where the error occurred, so it will make bug-fixing a lot easier, It also outputs how much time the function call has taken to quickly profile code. To enable it you just have to set the parameter verbosity from the client to INFO
or DEBUG
.
The INFO
keyword will be the most useful for visualizing the execution while DEBUG
is made so it outputs as much information as possible.
You can also set it to WARNING
but this is the default behavior and will have no effect, it will output only warnings and errors.
The logging level of the Shimoku SDK can be configured dynamically during execution by calling the s.configure_logging
function with the desired verbosity
level (either 'DEBUG', 'INFO', or 'WARNING') and an optional channel
to write the log output to. This allows for fine-grained control over the logging behavior and output, making it easier to debug and profile the SDK's execution.
When the SDK is set to execute asynchronously it does not stop for each request to finish before making a new one, speeding up a lot the execution (mostly in the plotting layer). To enable it, simply set the async_execution
parameter to True
when creating the client object:
By default, execution is set to sequential. You can toggle between sequential and asynchronous execution using the following functions:
When asynchronous execution is enabled, tasks are added to a task pool and executed once a strictly sequential task is reached. A function has been added to allow users to trigger the execution of tasks, which is s.run()
.
Be sure to call s.run()
at the end of your code to ensure all tasks are executed before the program terminates.
With an unlimited number of users
More on creating new users on Creating users.
Go to to create an account
Go ahead and copy paste to see