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

Update CoreNEURON documentation #950

Merged
merged 7 commits into from
Feb 1, 2021
Merged

Update CoreNEURON documentation #950

merged 7 commits into from
Feb 1, 2021

Conversation

pramodk
Copy link
Member

@pramodk pramodk commented Jan 31, 2021 •
edited
Loading

  • add detailed instructions for building and using CoreNEURON
  • Add example references
  • Copy BBCOREPOINTER document from CoreNEURON repo

This will to some of the questions raised in #943 #947

@pramodk
Update CoreNEURON documentation
c25e426 
 * add detailed instructions for building and using CoreNEURON
 * Add example references
@pramodk
Add bbcorepointer documentation
f992327
@pramodk
Change url of ringtest and minor updates
9b1a586
@pramodk pramodk marked this pull request as ready for review January 31, 2021 17:02
@pramodk pramodk requested a review from nrnhines January 31, 2021 17:03
@pramodk
Copy link
Member Author

pramodk commented Jan 31, 2021 •
edited
Loading

cc: @iomaganaris @alexsavulescu : I re-wrote some part but also started moving documentation from CoreNEURON to NEURON. I will update/remove coreneuron side next.

@pramodk pramodk requested a review from iomaganaris January 31, 2021 17:28
alexsavulescu
alexsavulescu approved these changes Jan 31, 2021
View reviewed changes
Copy link
Member

@alexsavulescu alexsavulescu left a comment

Choose a reason for hiding this comment

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

LGTM, small suggestions

docs/coreneuron/how-to/coreneuron.md Outdated Show resolved Hide resolved
docs/coreneuron/how-to/coreneuron.md Outdated Show resolved Hide resolved
@alexsavulescu
Copy link
Member

@pramodk since I've ben working on those notebooks lately :), maybe we could add one for CoreNEURON after my docs PR.

@pramodk @alexsavulescu
Apply suggestions from code review
046bf85 
Co-authored-by: Alexandru Săvulescu <[email protected]>
@pramodk
Copy link
Member Author

pramodk commented Jan 31, 2021

@alexsavulescu : do you mean we can merge this after your docs PR? Sure!
(It would be bit convenient to merge before C++ PR so that we can quickly merge master to release/8.0)

@alexsavulescu
Copy link
Member

alexsavulescu commented Jan 31, 2021 •
edited
Loading

@alexsavulescu : do you mean we can merge this after your docs PR? Sure!
(It would be bit convenient to merge before C++ PR so that we can quickly merge master to release/8.0)

No, was just saying we could create a CoreNEURON jupyter notebook (and wait for my docs PR before adding it). We can (systematically) cherry pick master commits to release/8.0

@pramodk
Copy link
Member Author

pramodk commented Jan 31, 2021

Ah ok! we can create notebook but we don't have coreneuron support under wheel. So it can come later.

@nrnhines nrnhines merged commit b661528 into master Feb 1, 2021
@nrnhines nrnhines deleted the pramodk/coreneuron-docs-update branch February 1, 2021 11:39
nrnhines added a commit that referenced this pull request Feb 2, 2021
@pramodk @nrnhines @alexsavulescu
Update CoreNEURON documentation (#950)
39213d6 
* Update CoreNEURON documentation
 * add detailed instructions for building and using CoreNEURON
 * Add example references

* Add bbcorepointer documentation

* Change url of ringtest and minor updates

* Update bbcorepointer.md

* Update coreneuron.md

* Update coreneuron.md

* Apply suggestions from code review

Co-authored-by: Alexandru Săvulescu <[email protected]>

Co-authored-by: nrnhines <[email protected]>
Co-authored-by: Alexandru Săvulescu <[email protected]>
@alexsavulescu alexsavulescu mentioned this pull request Apr 26, 2021
Closed
@alexsavulescu alexsavulescu mentioned this pull request Mar 22, 2022
Closed
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexsavulescu alexsavulescu alexsavulescu approved these changes

@iomaganaris iomaganaris iomaganaris approved these changes

@nrnhines nrnhines nrnhines approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@pramodk @alexsavulescu @nrnhines @iomaganaris