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

Add improve and generate documentation #1

Merged
merged 5 commits into from
Oct 21, 2024

Conversation

HannoSpreeuw
Copy link

The documentation has not been completed yet.
Still we want to merge this branch with main now.

The reason is that this branch was created off main recently, i.e. after the merge with the Use_solve_ivp_without_py-pde_wrapper branch.
After the merge we do not arrive at exactly the same oscillations as before the merge; the time of onset of the oscillations is the same, but e.g. the amplitudes differ.

An important aspect of our upcoming publication is the runs that were performed last August, i.e. prior to the merge.

For that reason I have created a release_v1.0.0 branch from commit 3cd8233, i.e. prior to merge.
This Add_improve_and_generate_documentation branch will be merged both here, i.e. with current main and with that release_v1.0.0 branch.

The documentation will be expanded on the release_v1.0.0 branch because it is targeting the release; i.e. scientists that want to reproduce our published results will be using the 1.0.0 release and the documentation should support them in doing so.

@HannoSpreeuw HannoSpreeuw self-assigned this Oct 21, 2024
@HannoSpreeuw HannoSpreeuw merged commit 0c0d844 into main Oct 21, 2024
1 check passed
@HannoSpreeuw HannoSpreeuw deleted the Add_improve_and_generate_documentation branch October 21, 2024 12:43
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.

1 participant