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.

Sign up for GitHub

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

Jump to bottom

Add documentation in Antora for Spring mesh generation example #33

Open
prudhomm opened this issue May 2, 2018 · 7 comments
Open

Add documentation in Antora for Spring mesh generation example #33

prudhomm opened this issue May 2, 2018 · 7 comments
Assignees
@prudhomm @vincentchabannes @francoisdh
Labels
domain:documentation Add or revise a unit of documentation type:feature A function or behavior that supports a new capability.
Milestone
Sprint Toolbox 20...

Comments

@prudhomm
Copy link
Member

prudhomm commented May 2, 2018

The geometry and mesh generation are done and documented from within Angiotk repository.
The generated mesh(es) should be uploaded to girder and then used in the subsequent steps

@vincentchabannes @francoisdh what do you think?
@prudhomm prudhomm added this to the Sprint Toolbox 2018.1 milestone May 2, 2018
@prudhomm prudhomm added domain:documentation Add or revise a unit of documentation type:feature A function or behavior that supports a new capability. labels May 2, 2018
prudhomm added a commit that referenced this issue May 2, 2018
@prudhomm
up #33
dfec01a 
- move MeshFromCenterlines and MeshFromMRI to own antora module
- added local preview for antora
prudhomm added a commit that referenced this issue May 2, 2018
@prudhomm
up #33
6987821
prudhomm added a commit that referenced this issue May 2, 2018
@prudhomm
up #33 [ci skip]
9610ac2
prudhomm added a commit that referenced this issue May 2, 2018
@prudhomm
up #33
c61fe28
prudhomm added a commit that referenced this issue May 3, 2018
@prudhomm
up #33
9048d5f
prudhomm added a commit that referenced this issue May 3, 2018
@prudhomm
up #33
8d87604
@prudhomm
Copy link
Member Author

The mesh generation should be described here
http://docs.feelpp.org/angiotk/0.1/centerlines/spring/
with the basic steps with some screenshots or better the vtkjs files to illustrate each steps of the scripts and the final step corresponding to the upload to girder.
it should not be too long as the explanation for the steps are provided elsewhere (links should be made though)
then the CFD and and CSM part should be moved to feelpp/toolbox#3 and feelpp/toolbox#4 respectively

@prudhomm prudhomm changed the title Add documentation in Antora for Spring example Add documentation in Antora for Spring mesh generation example May 11, 2018
@prudhomm prudhomm mentioned this issue May 11, 2018
Closed
francoisdh added a commit that referenced this issue May 14, 2018
@francoisdh
Adresses issue #33. Started documenting the spring mesh generation ex…
732329e 
…ample in docs/modules/centerlines/
francoisdh added a commit that referenced this issue May 14, 2018
@francoisdh
Addresses issue #33. Started documenting the spring mesh generation e…
dd4330e 
…xample in docs/modules/centerlines/
@francoisdh
Copy link
Contributor

About Girder: can I create a dedicated collection for AngioTK or should all the results (with intermediary steps) be stored in the feelpp one ?

@prudhomm
Copy link
Member Author

sure

@prudhomm
Copy link
Member Author

are there any issues with this ?

@francoisdh
Copy link
Contributor

Thank you. No issue at all. (I just wanted to make sure creating a new collection was ok with your vision of file management.)

@francoisdh
Copy link
Contributor

I just tried and sadly, I am not authorized to create one.

prudhomm pushed a commit that referenced this issue May 23, 2018
@francoisdh @prudhomm
fix issue #33: merge branch examples/spring (#36)
3361997 
* Addresses issue #33. Started documenting the spring mesh generation example in docs/modules/centerlines/

* changed version to 'latest' and removed useless attribute. The spring doc should be usable now.

* Update antora.yml

[ci skip]
@prudhomm
Copy link
Member Author

prudhomm commented Jun 7, 2018

should it be closed ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@prudhomm prudhomm

@vincentchabannes vincentchabannes

@francoisdh francoisdh

Labels
domain:documentation Add or revise a unit of documentation type:feature A function or behavior that supports a new capability.
Projects
None yet
Milestone
Sprint Toolbox 2018.1
Development

No branches or pull requests
3 participants
@prudhomm @vincentchabannes @francoisdh