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

Update install docs #345

Merged
merged 2 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/new_benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ assignees: ''

## Is the new benchmark computational or experimental?

- [x] Computational
- [] Experimental
- [ ] Computational
- [ ] Experimental

## Is this a MultiTest or a normal Test?
Specify here if the benchmark consists of only one transport run or it is a collection of input files that have the same general structure.
Expand All @@ -28,8 +28,8 @@ to be implemented.
Specify here for which codes the benchmark should be developed.

## Can inputs of this benchmark be freely re-distributed?
- [x] yes
- [] no
- [ ] yes
- [ ] no

If no, please specificy who will be able to access the inputs.

Expand All @@ -46,7 +46,7 @@ Some generic classes have been already developed for experimental classes of ben
can use one of these classes or a new one needs to be created.

## Can experimental data of this benchmark be freely re-distributed?
- [x] yes
- [] no
- [ ] yes
- [ ] no

If no, please specificy who will be able to access the experimental data.
4 changes: 4 additions & 0 deletions docs/source/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ JADE has now been installed as a command line tool and should now be initialised
| ``cd ../``
| ``jade``

If permissions errors are encountered, the user may instead run:

| ``python -m jade``

The folder strucure should now look like the following:
::
<JADE_root>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/usage/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Troubleshooting
###############

Unable to post-process a libray
===============================
Unable to post-process a library
================================

It may happen that the request to post-process a library fails, prompting to
video that the library in question has not been run.
Expand Down