-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
explain the two installation guides, add link to walk-through
- Loading branch information
1 parent
96444d0
commit be7783a
Showing
1 changed file
with
10 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -54,9 +54,13 @@ See also the accompanying [GitHub Page](https://inm-6.github.io/beNNch) for furt | |
|
||
## User guide | ||
|
||
### Community discussion | ||
There are two distinct sets of instructions on how to install beNNch: | ||
|
||
- the general documentation provided by the [User guide](https://github.com/INM-6/beNNch#user-guide) in this README | ||
- a [walk-through on our GitHub Page](https://inm-6.github.io/beNNch/walk-through.html) | ||
|
||
The former is a set of complete, abstract instructions with general placeholders where the user needs to insert information. The latter focuses on a concrete example and guides the reader with screen-shots while discussing small issues and best practices that have emerged when using beNNch in production. Depending on your previous experience you may find one or the other more intuitive. If set-up problems persist after following both approaches, don't hesitate to get into contact via the [Community discussion](https://github.com/INM-6/beNNch#community-discussion). | ||
|
||
We organize a discussion with a focus on both community usage and development synchronization. For details regarding space-time coordinates, contact [Jasper Albers](mailto:[email protected]?subject=[beNNch]%20Community%20Discussion%20Meeting). | ||
|
||
### Initialization | ||
|
||
|
@@ -229,6 +233,10 @@ with an arbitrarily long list of bullet items (consisting of metadata keys) that | |
- error `jinja2.exceptions.TemplateNotFound: index.html.j2` | ||
+ [issue](https://github.com/jupyter/nbconvert/issues/1394) with a recent version of `nbconvert`, try to install version `5.6.1` instead (e.g. `pip install nbconvert==5.6.1 --user`) | ||
|
||
### Community discussion | ||
|
||
We organize a discussion with a focus on both community usage and development synchronization. For details regarding space-time coordinates, contact [Jasper Albers](mailto:[email protected]?subject=[beNNch]%20Community%20Discussion%20Meeting). | ||
|
||
___ | ||
## Developer guide | ||
|
||
|