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

[Documentation] Rework for v0.2.2 #65

Merged
merged 57 commits into from
Mar 7, 2022
Merged

[Documentation] Rework for v0.2.2 #65

merged 57 commits into from
Mar 7, 2022

Conversation

skim0119
Copy link
Collaborator

@skim0119 skim0119 commented Mar 6, 2022

Documentation Update

Here is the sample build of the updated documentation pages. There might be a few updates/fixes that are necessary, but I think we can continue working on those in branch update-0.2.2.

https://docs.cosseratrods.org/en/doc_patch/index.html

Key Changes

  • The workflow and tutorial in the webpage are merged in the documentation page.
  • Each module is listed in the table.
  • Compatibility table is added to indicate which modules are supported in rigid body vs rod.
  • Advanced guide is added to archive important discussions.
  • Old information is removed, new information are added 😄

skim0119 and others added 30 commits February 6, 2022 23:11
Documentation updates using MyST
Porting getting started guide from website to docs page
@skim0119 skim0119 added documentation Improvements or additions to documentation update Update the codebase labels Mar 6, 2022
@skim0119 skim0119 added this to the Version 0.2.2 milestone Mar 6, 2022
@skim0119 skim0119 requested a review from armantekinalp March 6, 2022 05:41
@skim0119 skim0119 self-assigned this Mar 6, 2022
@codecov-commenter
Copy link

codecov-commenter commented Mar 6, 2022

Codecov Report

Merging #65 (e7df9a8) into update-0.2.2 (71bebe1) will increase coverage by 0.03%.
The diff coverage is 100.00%.

Impacted file tree graph

@@               Coverage Diff                @@
##           update-0.2.2      #65      +/-   ##
================================================
+ Coverage         86.41%   86.44%   +0.03%     
================================================
  Files                38       39       +1     
  Lines              2606     2612       +6     
  Branches            370      370              
================================================
+ Hits               2252     2258       +6     
  Misses              326      326              
  Partials             28       28              
Impacted Files Coverage Δ
elastica/_calculus.py 95.87% <ø> (ø)
elastica/callback_functions.py 79.74% <ø> (ø)
elastica/external_forces.py 95.65% <ø> (ø)
elastica/joint.py 25.17% <ø> (ø)
elastica/utils.py 98.18% <ø> (ø)
elastica/boundary_conditions.py 95.36% <100.00%> (ø)
elastica/rigidbody/cylinder.py 100.00% <100.00%> (ø)
elastica/rigidbody/rigid_body.py 54.54% <100.00%> (ø)
elastica/rigidbody/sphere.py 100.00% <100.00%> (ø)
elastica/rod/__init__.py 100.00% <100.00%> (ø)
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 71bebe1...e7df9a8. Read the comment docs.

Copy link
Contributor

@armantekinalp armantekinalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the changes we can merge this documentation. LGTM

docs/guide/example_cases.rst Outdated Show resolved Hide resolved
elastica/rod/cosserat_rod.py Outdated Show resolved Hide resolved
@armantekinalp
Copy link
Contributor

I also reformatted some documentation @skim0119

@skim0119 skim0119 changed the base branch from master to update-0.2.2 March 7, 2022 10:43
@skim0119 skim0119 merged commit 27330b6 into update-0.2.2 Mar 7, 2022
yeonsu-jung pushed a commit to yeonsu-jung/PyElastica that referenced this pull request Mar 14, 2022
* Update to resolve GazzolaLab#65 
  * new example that export the rod data
  * finish documentation, add test for ExportCallBack
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation update Update the codebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants