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.

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

added pecuzal method #63

Merged
merged 4 commits into from
Nov 17, 2020
Merged

added pecuzal method #63

merged 4 commits into from
Nov 17, 2020

Conversation

hkraemer
Copy link
Contributor

I added the PECUZAL method incl. tests.

@Datseris
Copy link
Member

I'll review once tests pass :)

@hkraemer
Copy link
Contributor Author

Hey @Datseris ,
fair enough.. these tests.. grrr! There you go ;)

@Datseris Datseris merged commit abcb894 into master Nov 17, 2020
@Datseris Datseris deleted the PECUZAL_embedding branch November 17, 2020 19:09
@Datseris
Copy link
Member

@hkraemer This is in and tagged as v1.14!

If you want to write some documentation and example for it in DynamicalSystems.jl this is of course welcomed. In principle what you have to do is edit the file https://github.com/JuliaDynamics/DynamicalSystems.jl/blob/master/docs/src/embedding/estimate.md . This is a markdown file that incorporates runnable Julia code. Everything inside a ```@example code block is runnable Julia code that will be evaluated and shown in the docs.

If there isn't a specific example you want to add it is fine, we simply add pecuzal_embedding in the ```@docs code block so that its documentation string is expanded.

@hkraemer
Copy link
Contributor Author

Alright, I will do that. One more question: If an example code block returns a figure I'd like to show in the docs right underneeth the code-block, how can I ensure that this is displayed? In your example with the optimal_traditional_de-method, you wrote fig.savefig("estimateD.png"); nothing # hide. So this Figure is saved and the line of code hided from getting displayed in the docs, but does that automatically mean, that the figure gets displayed?

Another question is how the Refs. are handled. On the very bottom of the documentation page all the Refs. from the doc-strings of the mentioned function get displayed. It this automated?

@Datseris
Copy link
Member

Datseris commented Nov 17, 2020

The refs are automated yes provided you do this [^Kraemer] thing.

For the figure, you will notice after the code block ends with the fig.savefig command, then next markdown command displays the figure, e.g. ![](estimateD.png)

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.

None yet

2 participants