Regarding the Result object

[Ssalazar12]

The result object is very obtuse to work with, it functions mostly like a black-box where one passes it to the predefined plotting functions. This is fine for quick calculations, but it is very tedious when one wants to go beyond what is readily available and handle the data directly. It would be very nice to have a function that lists the attributes contained in the Result object or something that gives and idea of the internal structure, It would make it easier to access the solutions and understand what is going on. It would also be nice to include a page specifically for this object in the documentation since it is the main thing one works with,

[oameye]

So recently, I have been changing the API a bit and more convenient function to acces the solutions (see here or here). That means we have:

• get_solutions
• get_single_solution
• attractors
• phase_diagram

Technically, you shouldn't need to use the plotting functions anymore and you could use the "extractor functions" and you can use your own plotting package. Where you aware?

We have a page where we dedicate to explain how to work with the Result object here. I would like to have the fieldnames (internal structure) of the Result struct to be in internal, i.e., non-public. Having this as non-public means we can change the internal structure without breaking people's code in future versions. That's why Result is not listed in the API.

Where you aware of the documentation pages? We maybe should clarify this somewhere :)

[Ssalazar12]

Thanks! I was aware of the documentation but found it difficult to find information regarding the Result class. I was not aware of the pages you linked for example. Maybe it would be good to add a short section to "Geting Started" dedicated to the Result class? Something that briefly introduces Result as the main object to work with, gives a high level overview of what it stores and then just links to the pages you sent me. I think that would guide a newcomer more on where to look in the docs