Open maxchumley opened 8 months ago
Agreed! I was just looking into the documentation and realized the same problem. We have the autodocumentation feature, this should be reasonable to add although likely will need a bunch of code annotation cleanup. What's the chance you two wanna take this on @maxchumley @stanweer1 ?
Nevermind, I'm gonna take this on. I'm reorganizing the entire documentation folder structure because of it, but i made a branch (see link to the right) if you want to poke around
Ok, so I just pushed the reorganization of the doc_source
folder to the branch. I haven't even started getting the DynSysLib autodocumentation working yet, but at least the structure feels more under control. Todos:
Ok, now I have a better sense of why this is a problem. @stanweer1 and @maxchumley I have a version of what I think we should do, so I'm hoping you two can go through the rest of the library and do something parallel.
I have all the rst files set up for DynSysLib and everything is autodocumenting in the branch associated to this issue. In particular, you can see the list of files in the DynSysLib page with the goal of eventually replacing the giant table.
The problem is that the simulations are inside one giant function in each .py file, so autodocumenting gives us no information. So, your job is to clean up the rest of the files in the folder with the following changes, doing everything in parallel to what I did for the Periodic Functions version.
periodic_functions.py
, I made a sine
and incommensurate_sine
function. Include any additional parameters as the variable inputs (so omega
if we're following the sine example), and everything should get default values equal to the defaults that would be input if they weren't extracted.periodic_functions
in this example) retains its default parameter choices, but does that by calling the system's function instead. Oops, that shouldn't have closed the issue. It's only partially fixed :D
There is no way to know the system key for simulation without opening the source code. The system key name should be documented in the PDF that outlines all available systems.
Some systems also subsample signals without warning so we should warn the user or remove any subsampling.